Version 24.3.9120

• Add the Jira Connector
• Authenticate to Jira
  • OAuth
  • Personal Access Token
  • API Token
  • Basic
  • Crowd
  • Okta
  • LDAP
• Complete Your Connection
• More Information

You can use the Jira connector from the CData Sync application to capture data from Jira and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Add the Jira Connector

To enable Sync to use data from Jira, you first must add the connector, as follows:

1. Open the Connections page of the Sync dashboard.

2. Click Add Connection to open the Select Connectors page.

3. Click the Sources tab and locate the Atlassian Jira row.

4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Atlassian Jira connector. For more information about installing new connectors, see Connections.

Authenticate to Jira

After you add the connector, you need to set the required properties.

• Connection Name - Enter a connection name of your choice.

• URL - Enter the URL for your Jira endpoint (for example, https://YourSiteName.atlassian.net).

CData Sync supports authenticating to Jira in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

• OAuth

• PAT

• APIToken

• Basic

• Crowd

• OKTA

• LDAP

OAuth

CData Sync provides an embedded OAuth application with which to connect. To use the application, select OAuth for Auth Scheme. No additional properties are required.

Personal Access Token

To connect with a personal access token, specify the following properties:

• Auth Scheme - Select PAT.

• PAT - Enter your personal access token (PAT). You can create a PAT either via from the Atlassian Settings menu or by using a REST API.

  From the Atlassian application:

  1. Select your profile photo at the top right of the screen.

  2. From the drop-down list, select Settings > Profile.

  3. In the left pane, select Personal Access Tokens.

  4. Click Create token. Then, give the new token a name.

  5. (Optional) Set your token to expire automatically after a certain number of days. (Atlassian displays a reminder message five days before the token actually expires, which gives you time to create a new token.)

     Note: According to the Atlassian Developer guide, the PAT persist for five years by default.

  6. Click Create. After the token is created, make sure to copy and save it because you cannot view or retrieve it later.

  From a REST API:

  To create a PAT by using the REST API, see “Creating PATS using REST API” in the Atlassian Using Personal Access Tokens documentation.

API Token

To connect with an API token, specify the following properties:

• Auth Scheme – Select Token.

• User - Enter the username that you use to authenticate to your Jira account.

• API Token - Enter your API token.

  To generate an API token in Atlassian:

  1. Log in to your Atlassian account.

  2. Select Security > Create and manage API tokens > Create API token.

Basic

To connect with your user credentials, set the following properties:

• Auth Scheme: Select Basic.

• User - Enter the username that you use to authenticate to your Jira account.

• Password - Enter the password that you use to authenticate to your Jira account.

Crowd

To connect with single sign-on (SSO) via Atlassian Crowd, specify the following properties:

• Auth Scheme – Select Token.

• User - Enter the username that you use to authenticate to your Jira account.

• Password - Enter the password that you use to authenticate to your Jira account.

• SSO Login URL - Enter the login URL that is used by your SSO provider.

• SSO Exchange UrI - Enter the URL that is used to exchange the Security Assertion Markup Language (SAML) token for Jira cookies. This URL can be in either of the following formats:

  • https://AuthorityofJiraInstance/plugins/servlet/samlconsumer

  • https://AuthorityofJiraInstance/plugins/servlet/samlsso

• SSO App Name - Enter the name of the application in which SSO is enabled.

• SSO App Password - Enter the password of the application in which SSO is enabled.

Okta

To connect with single sign-on (SSO) via Okta, specify the following properties:

• Auth Scheme – Select OKTA.

• User - Enter the username that you use to authenticate to your Okta account.

• Password - Enter the password that you use to authenticate to your Okta account.

• SSO Login URL - Enter the login URL that is used by your SSO provider.

• SSO Properties - Enter additional properties that are required to connect to your identity provider. You must use a semicolon-separated list of properties (for example, SSOProperty1=Value1;SSOProperty2=Value2;…).

• SSO Exchange UrI - Enter the URL that is used to exchange the Security Assertion Markup Language (SAML) token for Jira cookies. This URL can be in either of the following formats:

  • https://AuthorityofJiraInstance/plugins/servlet/samlconsumer

  • https://AuthorityofJiraInstance/plugins/servlet/samlsso

LDAP

To connect with LDAP credentials, specify the following properties:

• Auth Scheme - Select LDAP.

• User - Enter the username that you use to authenticate to your Jira account.

• Password - Enter the password that you use to authenticate to your Jira account.

Complete Your Connection

To complete your connection:

1. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

2. If you authenticate with OAuth, click Connect to Jira to connect to your Atlassian Jira account.

3. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and Jira, see Jira Connector for CData Sync.