> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/connector-configuration/jira.md).

# Jira

## OAuth app properties

| Property                | Value                                                                                                                                                                                                                                   |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Multi-tenant**        | **Conditional.** A new OAuth 2.0 (3LO) app is private: only its owner can use it. Once you turn on sharing (**Distribution**), users of any Atlassian Cloud site can authorize it.                                                      |
| **Vendor review**       | **None.** Review is optional. Until Atlassian approves the integration (through the Marketplace listing steps), users see a warning that the app has not been reviewed by Atlassian.                                                    |
| **Review time**         | Not applicable. Atlassian publishes no time for the optional review.                                                                                                                                                                    |
| **Users before review** | No limit, once sharing is on.                                                                                                                                                                                                           |
| **App owner**           | Any Atlassian account, in the [Developer Console](https://developer.atlassian.com/console/myapps/).                                                                                                                                     |
| **Regions**             | One app works for every Atlassian Cloud site. The connector reaches each site through `api.atlassian.com`.                                                                                                                              |
| **Client secret**       | No expiry documented.                                                                                                                                                                                                                   |
| **Rate limits**         | Since 2026-03-02: 65,000 points per hour per app in a global pool shared by all sites (Tier 1). Per-site quotas (Tier 2) only after Atlassian review. Plus per-endpoint burst limits per site and 20 writes per 2 seconds on one issue. |
| **Checked**             | 2026-11-13                                                                                                                                                                                                                              |

**Limitations**

* All your Appmixer users share the app's hourly points quota across all Jira sites. A busy flow on one site can make requests fail with `429` on another. Atlassian does not raise the quota on request.
* A connected account stops working when its refresh token is not used for 90 days. The user then connects the account again.
* Atlassian keeps one grant per app and Atlassian account. When a user consents for another site, it is added to the same grant; set **JIRA Cloud Site** when connecting to choose the site the account works with.
* Users who pick only some sites on the consent screen (resource-level grant) get tokens that work only for those sites.

Sources: [OAuth 2.0 (3LO) apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/), [Rate limiting](https://developer.atlassian.com/cloud/jira/platform/rate-limiting/). What the rows mean: [OAuth app properties](https://docs.appmixer.com/connector-configuration/oauth-app-properties.md).

### Register OAuth app

You can find all the necessary information on how to register an OAuth app in Jira in their [official guide](https://developer.atlassian.com/cloud/oauth/getting-started/managing-oauth-apps/).

Access [Attlassian Developer Console](https://developer.atlassian.com/console/myapps/) and create a new app. Click Create and select OAuth 2.0 integration.

Click on the "Register an app" button.

### Set up distribution

When you create an OAuth 2.0 (3LO) app, it's private by default. This means that only you can install and use it. If you want to distribute your app to other users, you must enable sharing.

Please follow the instructions in the [official guide](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/#distributing-your-oauth-2-0--3lo--apps) to set up distribution.

#### Specify scopes

You need to specify the scopes that your app will use. The Jira connector uses **classic** scopes for issue and instance operations, and **granular** scopes for project operations.

> **Note:** The **granular** project scopes below apply to **Jira connector version 4.0 and newer**. Older connector versions use the classic `manage:jira-configuration` scope for project operations instead.

> **Why granular scopes for projects?** With classic scopes, creating, updating or deleting a Jira project requires `manage:jira-configuration` — a broad administrative scope that grants access to **all** Jira configuration (workflows, schemes, screens, custom fields, …). To stay least‑privilege, the connector instead uses Jira's narrow **granular** project scopes (e.g. `write:project:jira` to create/update, `delete:project:jira` to delete), so **no broad admin scope is required**.

Enable **all** of the following scopes:

**User identity**

* `read:me`

**Classic — issues & instance**

* `read:jira-work`
* `write:jira-work`
* `read:jira-user`

**Granular — projects**

* `read:project:jira`
* `write:project:jira`
* `delete:project:jira`
* `write:project.avatar:jira`
* `read:project.property:jira`
* `read:project.component:jira`
* `read:project-category:jira`
* `read:project-version:jira`
* `read:issue-type:jira`
* `read:issue-type-hierarchy:jira`
* `read:user:jira`
* `read:avatar:jira`
* `read:group:jira`
* `read:application-role:jira`

> **Important:** Granular scopes are defined **per endpoint** and must **all** be enabled. Reading or updating a project, for example, requires the **full** set of `read:*` project scopes above — not just `read:project:jira`. A missing scope causes a runtime `401 Unauthorized; scope does not match`. (`offline_access` is requested automatically by the connector.)

This is how the permissions should look like:

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-be0c403b42d9a6f4a27f5564443e7099036a655c%2Fjira-2.png?alt=media" alt=""><figcaption><p>Specify scopes</p></figcaption></figure>

#### Specify Callback URL

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-0d2620cc4ffafd8dfabdcc646d72939f6547decd%2Fjira-4.png?alt=media" alt=""><figcaption><p>Specify callback URL</p></figcaption></figure>

#### Overview

After you have created the app, you will see the overview of the app. Here you can find the client ID and client secret.

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-8b7ce3edaeb97b917343296eda233b446b901aa9%2Fjira-3.png?alt=media" alt=""><figcaption><p>Settings with clientId and clientSecret</p></figcaption></figure>

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-f4b0fc66b930c76c993ac403df6f206dd7503b83%2Fjira-1.png?alt=media" alt=""><figcaption><p>Overview of the new app</p></figcaption></figure>

## Backoffice configuration

Configuration ID: `appmixer:jira` (Backoffice → Configuration; see [Connector Configuration](https://docs.appmixer.com/getting-started/services) for how a configuration is created and how its keys reach the connector).

* `clientId` — Client ID of the Atlassian OAuth 2.0 app registered above. Not needed when Jira is authenticated through the Appmixer Auth Hub.
* `clientSecret` — Client secret of the same app. Not needed with the Auth Hub.
* `outputFilePrefix` — Optional. File name prefix of the CSV file that **FindIssues** and **GetIssueTransitions** create when their output is set to a file. Default `jira-export`.

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-03bea4fe315f6b401b4a20fbb25216380a548a54%2Fjira-5.png?alt=media" alt=""><figcaption><p>Backoffice JIRA connector configuration</p></figcaption></figure>

The same keys can be set with the CLI (`-u` updates the existing configuration instead of creating it):

```bash
appmixer service-config set appmixer:jira -u -d '{
  "clientId": "<client id>",
  "clientSecret": "<client secret>"
}'
```


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.appmixer.com/connector-configuration/jira.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
