Integrating with Jira

Overview

Prerequisites

Jira Setup

Method 1: Basic

Method 2: OAuth 2.0 (3LO)

Troubleshooting

Overview

This guide will walk you through connecting your Jira account to Drivetrain. Drivetrain supports two integration methods:

1. Method 1: Basic Authentication

   Connect using Jira credentials (Jira On-Premises) or an Atlassian email + basic API token (Jira Cloud).

2. Method 2: OAuth 2.0 (3LO)

   Connect using an authorisation flow for Jira Cloud.

Both methods require that the credentials provided have the appropriate permissions to read the specified objects.

Prerequisites

Before beginning the integration, ensure you have the following:

1. An active Jira account.

2. Admin privileges in Drivetrain.

3. The Jira user account that you use to connect must have the following permissions:

Entities	Roles & Permissions
Projects Issues Related entities like versions, components, and boards	Administer Projects or Browse Projects permission
Project roles Project role actors	Administer Projects permission
Users Groups	Browse users and groups global permission
Entities related to Jira Service Management (formerly Jira Service Desk)	Administrators or Service Desk Team project role
Permission and issue security schemes Related entities Webhooks (for registration)	Administer Jira global permission

Jira Setup

Follow the steps below basis the method chosen to integrate your Jira instance on Drivetrain:

Method 1: Basic

How you set up Basic authentication depends on which type of Jira installation you have:

1. Jira On-Premises

   • Step 1: Configure Jira for authentication

     1. Store your Username and Password.

   • Step 2: Integrating with Drivetrain

     1. Share the following details securely with your Drivetrain implementation team:

        • Username & Password (created in Step 1)

        • Jira Host

        • Port number

2. Jira Cloud

   • Step 1: Configure Jira for authentication

     1. In your Atlassian account, create a basic API token by clicking Create API token and store it.

        • In order to create an API token with scopes:

          • Log in to https://id.atlassian.com/manage-profile/security/api-tokens.

          • Select Create API token with scopes.

          • Give your API token a name that describes its purpose.

          • Select an expiration date for the API token.

          • Select the app you’d like the API token to access.

          • Select the scopes to determine what the API token can do in Jira or Confluence.

          • Select Create.

          • Select Copy to clipboard, then paste the token to your script, or save it somewhere safe.

   1. Store the email address for the Atlassian account you used to create the API token.

   • Step 2: Integrating with Drivetrain

     1. Share the following details securely with your Drivetrain implementation team:

        • Email Address & API Token from your Atlassian Account (created in Step 1)

        • Jira Host

        • Port number

Token expiration is 1 to 365 days.

Method 2: OAuth 2.0 (3LO)

Follow the steps below to integrate your Jira instance on Drivetrain:

1. The Drivetrain team will send you the authentication link for Jira.

2. In the setup form, enter your Jira Host, Port number and set the Authentication Type to OAuth .

3. Click Authorize to start the OAuth 2.0 authorization flow.

4. Log in with the Atlassian account that has access to the Jira Cloud instance you are connecting to.

5. Review on the Permissions page, the requested scopes and click Allow access to grant Drivetrain access to your Jira data.

6. Upon granting access, you are automatically redirected back to the Drivetrain dashboard.

No further manual configuration is required. The Jira source will start syncing data using the granted OAuth 2.0 access.

Troubleshooting

If you’re unable to connect Jira to Drivetrain after completing the steps above, reach out to your Drivetrain onboarding partner. In most cases, no additional configuration is required.

Include a screenshot or brief description of the error message. We'll help you troubleshoot and guide you through next steps.