Establishing a Connection
Connecting to JIRA
(Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.)
Obtaining an API TokenAn API token is necessary for account authentication. To generate one, log in to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.
Accessing Custom Fields
By default the provider surfaces only system fields. To access the custom fields for Issues, set IncludeCustomFields.
Using SSO Authentication
The provider has support for SSO authentication. You can enable it using UseSSO connection property. The following SSO providers are available: CROWD.
Crowd SSO Provider
The Crowd identity provider can only be integrated with a JIRA data server instance. Please refer to JIRA's documentation for detailed instructions.
Authenticate Using Crowd
You need to include the following properties in your connection string:
- SSOProvider: Set this property to "CROWD".
- SSOUser: The CROWD user account.
- SSOPassword: The password associated with the Crowd account.
- SSOLoginUrl: The login URL associated with the Crowd account. You can find the IDP URL by navigating to your application -> SSO -> SSO information -> Identity provider single sign-on URL.
- AppName: The name of the application in which SSO is enabled.
- AppPassword: The password of the application in which SSO is enabled.
- ACSUrl: You can find the Assertion Consumer Service URL by navigating to your application -> SSO -> Application Details -> Assertion Consumer Service URL.
Customizing the SSL Configuration
By default, the provider attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.
Connecting Through a Firewall or Proxy
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
- To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
- To tunnel the connection, set FirewallType to TUNNEL.
- To authenticate, specify FirewallUser and FirewallPassword.
- To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.
Troubleshooting the Connection
To show provider activity from query execution to network traffic, use Logfile and Verbosity. The examples of common connection errors below show how to use these properties to get more context. Contact the support team for help tracing the source of an error or circumventing a performance issue.
- Authentication errors: Typically, recording a Logfile at Verbosity 4 is necessary to get full details on an authentication error.
- Queries time out: A server that takes too long to respond will exceed the provider's client-side timeout. Often, setting the Timeout property to a higher value will avoid a connection error. Another option is to disable the timeout by setting the property to 0. Setting Verbosity to 2 will show where the time is being spent.
- The certificate presented by the server cannot be validated: This error indicates that the provider cannot validate the server's certificate through the chain of trust. If you are using a self-signed certificate, there is only one certificate in the chain.
To resolve this error, you must verify yourself that the certificate can be trusted and specify to the provider that you trust the certificate. One way you can specify that you trust a certificate is to add the certificate to the trusted system store; another is to set SSLServerCert.