Articles in this section

Set up a connection to Jira

Naga Sri Hari Gonaboyina
Updated

Jira helps to build agile work management and supports your team to plan, track, and manage their work.

Set up a connection

After you start the connection, configure it in the Create connection panel and complete all of the required *authentication settings: 

Setting

Instructions

Name your connection * 

Enter a clear and distinguishable name.

Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

API type *

Choose your Jira account API type:

  • Cloud Platform and Service Management: Create and manage core Jira resources such as issues, projects, users, workflows, and permissions across Jira Software and Jira Service Management.

  • Customer Service Management: Create support requests, manage SLAs, and automate customer communication workflows in service desk projects.

API type: Cloud platform and Service management

Subdomain * 

Enter your Jira subdomain.

For example, if https://demo.atlassian.netis your URL, thendemois the subdomain.

Auth type *

Select your Jira account authentication type (either Basic or OAuth 2.0).

Username *  (if auth type is Basic)

Enter your Jira account username.

API token * 

Enter your Jira API token.

Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s API token safe. When editing this form later, you must enter this token again; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API token 

OAuth 2.0 client *

Select the OAuth 2.0 client that stores the client ID and client secret provided by Jira.

dataLoad.svg​​ How to retrieve the client ID and client secret

To add an OAuth 2.0 client and configure your credentials, click the plus (+) button. Click the edit () button to modify a selected OAuth 2.0 client. For more information, see Create an OAuth 2.0 iClient resource.

Scopes *

Scopes are OAuth 2.0 permissions that Jira defines to limit access to your account.

dataLoad.svg​​ How to configure scopes

API type: Customer service management

OAuth 2.0 client *

Select the OAuth 2.0 client that stores the client ID and client secret provided by Jira.

dataLoad.svg​​ How to retrieve the client ID and client secret

To add an OAuth 2.0 client and configure your credentials, click the plus (+) button. Click the edit () button to modify a selected OAuth 2.0 client. For more information, see Create an OAuth 2.0 iClient resource.

Scopes *

Scopes are OAuth 2.0 permissions that Jira defines to limit access to your account.

dataLoad.svg​​ How to configure scopes

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see OAuth 2.0 auth universal connector documentation.

How to retrieve the API token

  1. Sign in to your Atlassian account.

  2. Navigate to Atlassian account settings > Security > API token > Create and manage API tokens.

  3. Copy the API token.

How to retrieve the client ID and client secret

  1. Sign in to your Atlassian developer console.

  2. Navigate to Profile icon >.Developer console > Create > OAuth 2.0 integration.

  3. Give an app name and click Create.

  4. Select the Permissions.

  5. Select the Scopes.

  6. In Authorization, paste the callback URL (such as https://integrator.io/connection/oauth2callback).

  7. Navigate to Settings.

  8. Copy the Client ID.

  9. Copy the Client secret.

How to configure scopes

  1. Click Scope.

  2. To access all of the scopes in the API, click the » button.

    – or – 

    Select the scopes you want to add and click the > button.

  3. Click Save.

Additional references