ODBC Driver for Jira Service Management

Build 24.0.9060

Windows DSN Configuration

Using the Microsoft ODBC Data Source Administrator

You can use the Microsoft ODBC Data Source Administrator to edit the DSN configuration. Note that the DSN is created during the installation process.

Complete the following steps to edit the DSN configuration:

  1. Select Start > Search, and enter ODBC Data Sources in the Search box.
  2. Choose the version of the ODBC Administrator that corresponds to the bitness of your application (32-bit or 64-bit).
  3. Click the System DSN tab.
  4. Select the system data source and click Configure.
  5. Edit the information on the Connection tab and click OK.

Note: For .NET Framework 4.0, the driver distributes Microsoft Visual C++ 2015-2022 Redistributable. For .NET Framework 3.5, the driver distributes Microsoft Visual C++ 2008 Redistributable.

Ensuring Registry Access

The driver stores connection information in the Windows registry. To ensure that the driver can write to the registry, perform either of the following actions:

  1. Run the calling application as an administrator.
  2. Connect via a User DSN instead of a System DSN.

Connecting to Jira Service Management

You can establish a connection to any Jira Service Management Cloud account or Jira Service Management Server instance. To connect set the following property:

  • URL (for example: https://yoursitename.atlassian.net).

Accessing Custom Fields

By default, the driver surfaces only system fields. To access the custom fields for Issues, set IncludeCustomFields.

Authenticating to Jira Service Management

Jira Service Management supports authentication through Basic, API Token, Crowd, OAuth 2.0, OAuth 1.0 (hosted Jira users only), or Okta.

Basic

In Basic authentication the user logs in with credentials for a local server account. Set these connection properties:
  • AuthScheme: Basic.
  • User: The username of the authenticating user.
  • Password: The authenticating user's password.

API Token

API Token authentication, used to connect to a Cloud account, requires you to generate and retrieve an APIToken. To do this, log in to your Atlassian account and navigate to API tokens > Create API token. The generated token is displayed.

After you have created and obtained the API Token, set these connection properties:

  • AuthScheme: APIToken.
  • User: The username of the authenticating user.
  • Password (Sever Instances only): The password of the authenticating user.
  • APIToken: The API token you just retrieved.

Crowd

Set the AuthScheme to Crowd, then configure these connection properties:

  • User: The CROWD user account.
  • Password: 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.
  • SSOAppName: The name of the application in which SSO is enabled.
  • SSOAppPassword: The password of the application in which SSO is enabled.
  • SSOExchangeUrl: The URL used used to exchange the SAML token for Jira Service Management cookies. This URL may have the following formats:
    • https://<authority of Jira Service Management instance>/plugins/servlet/samlconsumer
    • https://<authority of Jira Service Management instance>/plugins/servlet/samlsso

Example connection string: 

AuthScheme=Crowd;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://<authority>/crowd/console/secure/saml/sso.action';User=crowdUserName;Password=crowdPassword;SSOExchangeUrl=https://<authority of Jira Service Management instance>/plugins/servlet/samlconsumer;SSOAppName=CrowdAppName;SSOAppPassword=CrowdAppPassword;

OAuth 2.0

You can leverage Jira Service Management's "three-legged" OAuth 2.0 support (3LO) to connect to data without providing your login credentials. Using OAuth 2.0 authentication requires you to create and configure a custom OAuth application, as described in Creating a Custom OAuth Application.

Desktop Applications

After you have created a custom OAuth application and have set these configuration parameters, you are ready to connect:

  • AuthScheme: OAuth.
  • InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • OAuthClientId: The client Id assigned when you registered your application.
  • OAuthClientSecret: The client secret assigned when you registered your application.
  • CallbackURL: The redirect URI defined when you registered your application.
  • Url: The URL to your Jira Service Management endpoint. For example, https://yoursitename.atlassian.net.
  • OAuthVersion: 2.0.
When you connect, the driver opens Jira Service Management's OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver refreshes the access token automatically when it expires.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you must set AuthScheme to OAuth and authenticate on another device that has an internet browser.

  1. Choose one of two options:
    • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
    • Option 2: Install the driver on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
  2. Then configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

  1. Set these properties:
    • InitiateOAuth: OFF.
    • OAuthClientId: The client Id assigned when you registered your application.
    • OAuthClientSecret: The client secret assigned when you registered your application.
    • OAuthVersion: 2.0.
    Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
  2. Log in and grant permissions to the driver. You are then sent to the redirect URI. There is a parameter called code appended to the redirect URI. Note the value of this parameter. Later you need this to set the OAuthVerifier connection property.
Next, you must exchange the OAuth verifier code for OAuth refresh and access tokens.

To obtain the OAuth authentication values, set these connection properties on the headless machine:

  • InitiateOAuth: REFRESH.
  • OAuthVerifier: The noted verifier code (the value of the code parameter in the redirect URI).
  • OAuthClientId: The client Id in your custom OAuth application settings.
  • OAuthClientSecret: The client secret in the custom OAuth application settings.
  • OAuthSettingsLocation: Set to persist the encrypted OAuth authentication values to the specified location.

Test the connection to generate the OAuth settings file, then re-set the following properties to connect:

  • InitiateOAuth: REFRESH.
  • OAuthClientId: The client Id assigned when you registered your application.
  • OAuthClientSecret: The client secret assigned when you registered your application.
  • OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the driver to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above, in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data, set these properties on the headless machine:

  • InitiateOAuth: REFRESH.
  • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
  • OAuthSettingsLocation: The location of the OAuth settings file you copied from the machine with the browser. Make sure this location gives read and write permissions to the driver to enable the automatic refreshing of the access token.

OAuth1.0 (Hosted Jira Users Only)

OAuth 1.0a is a deprecated authentication protocol, and should only be used by hosted Jira users. (It should not be not be used in Jira Cloud.) We recommend that all users switch to OAuth 2.0. You can use the OAuth 2.0 version by setting the OAuthClientId with the OAuthAccessToken connection property.

If you are a hosted Jira user and want to connect via OAuth 1.0, do the following:

  1. To generate an RSA public/private key pair, run the following commands in your terminal: 
    -openssl genrsa -out jira_privatekey.pem 1024
    
-openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365
    
-openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8
    
-openssl x509 -pubkey -noout -in jira_publickey.cer  -out jira_publickey.pem
  2. To create application links in your account, navigate to Settings > Applications > Application links.
  3. Enter a test URL for the url field and click Create new link.
    Ignore the error and click continue. We only want to configure incoming calls from the application to Jira Service Management.
  4. In the Link applications window, fill in the fields as you like.
  5. Select Create incoming link, then click Continue.
  6. Fill in the required fields:
    • Consumer Key: Set to any string. This string later becomes the OAuthClientId.
    • Consumer Name: Set to any string.
    • Public key: Enter the key from the jira_publickey.pem file you generated earlier.
  7. Click continue.
To connect, set these properties:

  • URL: Your Jira Service Management endpoint. For example, https://yoursitename.atlassian.net.
  • OAuthClientId: The Consumer Key of your application.
  • OAuthClientSecret: Any value (such as "testClientSecret").
  • OAuthJWTCert: The location of your private key file.
  • OAuthJWTCertType: The appropriate option based on the private key file you are using. If you are using the generated PEM key file, set OAuthJWTCertType to PEMKEY_FILE.
  • InitiateOAuth: Set to GETANDREFRESH.

Okta

To connect to Okta, set the AuthScheme to Okta, and set these properties:

  • User: The Okta user.
  • Password: The Okta user's password.
  • SSOLoginURL: The SSO provider's login URL.
  • SSOExchangeUrl: The URL used used to exchange the SAML token for Jira Service Management cookies. This URL may have the following formats:
    • https://<authority of Jira Service Management instance>/plugins/servlet/samlconsumer
    • https://<authority of Jira Service Management instance>/plugins/servlet/samlsso

If you are using a trusted application or proxy that overrides the Okta client request OR configuring MFA, you must use combinations of SSOProperties to authenticate using Okta. Set any of the following, as applicable:

  • APIToken: When authenticating a user via a trusted application or proxy that overrides the Okta client request context, set this to the API Token the customer created from the Okta organization.
  • MFAType: If you have configured the MFA flow, set this to one of the following supported types: OktaVerify, Email, or SMS.
  • MFAPassCode: If you have configured the MFA flow, set this to a valid passcode.
    If you set this to empty or an invalid value, the driver issues a one-time password challenge to your device or email. After the passcode is received, reopen the connection where the retrieved one-time password value is set to the MFAPassCode connection property.
  • MFARememberDevice: True by default. Okta supports remembering devices when MFA is required. If remembering devices is allowed according to the configured authentication policies, the driver sends a device token to extend MFA authentication lifetime. If you do not want MFA to be remembered, set this variable to False.

Example connection string: 

AuthScheme=Okta;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;SSOExchangeUrl=https://<authority of Jira Service Management instance>/plugins/servlet/samlconsumer;

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060