Connection String Options
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | Specifies the authentication scheme used to connect to the Jira instance. |
| URL | Specifies the URL to your Jira endpoint. It is typically the URL of your Atlassian instance, such as https://yoursitename.atlassian.net. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| APIToken | The API Token used to authenticate the current user. This token is required for API access and is unique to the user. |
| APITokenType | Specifies the format of the APIToken authentication. Supports Basic (default) and Bearer. |
| PAT | The Personal Access Token (PAT) used to authenticate the current user. The PAT is an alternative to using passwords and is used for accessing resources within the Atlassian ecosystem, such as Jira or Confluence. This token provides a secure, token-based authentication method for API calls, eliminating the need to expose the user's password directly. |
| Property | Description |
| SSOLoginURL | The identity provider's login URL. |
| SSOProperties | Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. |
| SSOExchangeURL | The URL used for consuming the SAML response and exchanging it for service specific credentials. |
| SSOAppName | App Name used with SSO for IdPs that require it. |
| SSOAppPassword | App Password used with SSO for IdPs that require it. |
| Property | Description |
| InitiateOAuth | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. |
| OAuthVersion | Identifies the version of OAuth being used. |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| OAuthAccessToken | Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
| OAuthAccessTokenSecret | The OAuth access token secret for connecting using OAuth. |
| Scope | Specifies the OAuth scopes that the application requests from Jira. Scopes define the level of access granted to the OAuth application. |
| OAuthSettingsLocation | Specifies the location of the settings file where OAuth values are saved. |
| CallbackURL | Identifies the URL users return to after authenticating to Jira via OAuth (Custom OAuth applications only). |
| CloudId | The Cloud Id associated with the Atlassian site that has been authorized during the OAuth 2.0 authentication process. This unique identifier is assigned to the Atlassian site and is used for distinguishing different cloud instances when interacting with APIs or services within the Atlassian ecosystem. |
| OAuthVerifier | Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
| AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
| AuthKey | The authentication secret used to request and obtain the OAuth Access Token. |
| OAuthRefreshToken | Specifies the OAuth refresh token used to request a new access token after the original has expired. |
| OAuthExpiresIn | Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
| OAuthTokenTimestamp | Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created. |
| CertificateStoreType | Specifies the type of certificate store used for Jira private application authentication. |
| CertificateStore | Specifies the certificate store used for Jira authentication. The certificate store contains the client certificate that is used to authenticate the client application with the service. |
| CertificateSubject | Specifies the subject of the client certificate used for Jira private application authentication. The certificate subject is a Distinguished Name (DN) that identifies the certificate and is used during the SSL client authentication process. It helps locate the correct certificate in the store by matching the provided subject information. |
| CertificateStorePassword | Specifies the password used to open the certificate store for authentication with Jira, if the certificate store is password-protected. |
| Property | Description |
| SSLClientCert | Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection. |
| SSLClientCertType | Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source. |
| SSLClientCertPassword | Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access. |
| SSLClientCertSubject | Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store. |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
| MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
| CacheProvider | The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations. |
| CacheDriver | The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations. |
| CacheConnection | Specifies the connection string for the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True. |
| Offline | Gets the data from the specified cache database instead of live Jira data. |
| CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
| Property | Description |
| AcceptLanguage | Set this property to send the Accept-Language request header in HTTP requests, which is used by servers to determine the preferred language for content delivery. |
| IncludeCustomFields | A Boolean property that indicates whether custom fields should be included in the column listing of the Issues table. When enabled, this option ensures that any custom fields added to the system are displayed as part of the issue metadata, providing a more comprehensive view of the issues. |
| IncludeMetadataDescription | Specifies whether custom field descriptions should be retrieved. Set this property to 'Columns' to retrieve descriptions for custom fields. |
| KeyColumnOperators | Specifies how to handle logical and comparison operators applied to Id and Key columns when constructing JQL filters. This property helps manage cases where invalid Id or Key values in JQL filters might otherwise lead to errors or unexpected results, particularly when paired with the UseJqlSearchEndpoint connection property on Jira Cloud. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MaxThreads | Specifies the number of concurrent requests that can be issued simultaneously. This property allows for the execution of multiple requests at the same time, which can improve overall performance by utilizing system resources more efficiently. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Jira. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Readonly | Toggles read-only access to Jira from the provider. |
| RTK | Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| Timezone | Specifies the timezone of the Jira instance to use datetime filters effectively and retrieve results based on the specified timezone. |
| UseDefaultOrderBy | Indicates whether a default ORDER BY clause should be applied when none is specified in the query. This helps ensure consistent sorting of results and prevents duplicate records from appearing in the output. |
| UseDisplayNames | A Boolean property that determines whether the display names for custom fields should be used instead of their corresponding API names. When enabled, this option will cause the system to use user-friendly display names for custom fields in the UI or API responses, making it easier for users to interpret the data. |
| UseJqlSearchEndpoint | Enables the use of the new **/rest/api/2/search/jql** endpoint for querying issues and related entities in Jira Cloud. This new endpoint allows for more advanced and flexible querying capabilities as part of the evolving API standards in Jira Cloud. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Specifies whether or not simple names should be used for tables and columns. |