> For the complete documentation index, see [llms.txt](https://integrations.drivetrain.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.drivetrain.ai/integration-guide/integrate-with-drivetrain/others/integrating-with-jira.md).

# Integrating with Jira

[Overview](#overview)

[Prerequisites](#prerequisites)

[Jira Setup](#jira-setup)

&#x20;   [Method 1: Basic](#method-1-basic)

&#x20;   [Method 2: OAuth 2.0 (3LO)](#method-2-oauth-2.0-3lo)

[Troubleshooting](#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                                       |
| ----------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| <p>Projects<br>Issues<br>Related entities like versions, components, and boards</p>             | **Administer Projects** or **Browse Projects** permission |
| <p>Project roles<br>Project role actors</p>                                                     | **Administer Projects** permission                        |
| <p>Users<br>Groups</p>                                                                          | **Browse users and groups** global permission             |
| Entities related to Jira Service Management (formerly Jira Service Desk)                        | **Administrators** or **Service Desk Team** project role  |
| <p>Permission and issue security schemes<br>Related entities<br>Webhooks (for registration)</p> | **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

{% hint style="warning" %}
Token expiration is **1 to 365 days.**
{% endhint %}

#### **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.

<figure><img src="/files/szyjuCrpNrMR11738hzT" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
No further manual configuration is required. The Jira source will start syncing data using the granted OAuth 2.0 access.
{% endhint %}

### **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.

{% hint style="warning" %}
Include a **screenshot** or **brief description** of the error message. We'll help you troubleshoot and guide you through next steps.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://integrations.drivetrain.ai/integration-guide/integrate-with-drivetrain/others/integrating-with-jira.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
