> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onyx.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Jira

> Access issues and projects from Jira

## How it works

The Jira connector pulls in all tickets from the specified projects every **10** minutes.

For every jira issue this connector will pull:

* Title
* Description
* [Common fields](#indexed-metadata)
* Comments

## Setting up

### Authorization

<Steps>
  <Step title="Jira Cloud token">
    **Jira Cloud**:
    follow the guide described
    [here](https://docs.searchunify.com/Content/Content-Sources/Atlassian-Jira-Confluence-Authentication-Create-API-Token.htm)
    to get an access token.
  </Step>

  <Step title="Jira Server token">
    **Jira Server**:
    follow the guide described
    [here](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html)
    to get a personal access token.
  </Step>
</Steps>

### Indexing

<Steps>
  <Step title="Open Jira connector">
    Navigate to the Admin Panel and select the **Jira** Connector
  </Step>

  <Step title="Provide credentials">
    For Cloud, provide the **Access Token** and the **Username** it belongs to:

    <img className="rounded-image" src="https://mintcdn.com/danswer/24Ocig51qMqahMaT/assets/admins/connectors/jira/JiraCloudAuth.png?fit=max&auto=format&n=24Ocig51qMqahMaT&q=85&s=fd4e1906c2d5212f319fb433aac79762" alt="Onyx Jira Cloud connector authentication form" width="1702" height="1056" data-path="assets/admins/connectors/jira/JiraCloudAuth.png" />

    For Server, provide the **Personal Access Token**:

    <img className="rounded-image" src="https://mintcdn.com/danswer/24Ocig51qMqahMaT/assets/admins/connectors/jira/JiraServerAuth.png?fit=max&auto=format&n=24Ocig51qMqahMaT&q=85&s=3ea9dc0b1567f800146967be662365e1" alt="Onyx Jira Server connector personal access token form" width="1746" height="624" data-path="assets/admins/connectors/jira/JiraServerAuth.png" />
  </Step>

  <Step title="Choose projects and filters">
    For each project you want to index, provide a single URL to any page in the project.
    Optionally specify users whose comments should not be indexed (useful to ignore certain bots). For example:

    <img className="rounded-image" src="https://mintcdn.com/danswer/24Ocig51qMqahMaT/assets/admins/connectors/jira/JiraIndex.png?fit=max&auto=format&n=24Ocig51qMqahMaT&q=85&s=bd14f57d7f5bb7f225e0e740c7fbbd36" alt="Jira indexing configuration showing project URLs and excluded commenters" width="1248" height="1468" data-path="assets/admins/connectors/jira/JiraIndex.png" />
  </Step>

  <Step title="Start indexing">
    Click the `Connect` button! All your Jira tickets in that space will now be pulled into Onyx every **10** minutes.
  </Step>
</Steps>

### Indexed metadata

```
- Project ID
- Issue Type
- Issue Key
- Summary
- Description
- Priority
- Labels
- Assignee
- Reporter
- Comments
- Status
- Resolution
- Created
- Updated
```