# Jira (prebuilt connector)

## Description

**Jira** (developed by Atlassian) is a software solution that allows bug tracking, issue tracking and agile project management.

## API documentation

API documentation for **Jira** (used to build this connector) can be found via the link below:

{% embed url="<https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#version>" %}

## Authentication&#x20;

When adding connector instances for **Jira**, the following authentication methods are supported:

* [Basic authentication](#basic-authentication)

### Basic authentication

When a user chooses to [add a connector instance](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance) using **basic** authentication, the credentials below are prompted:

<table><thead><tr><th>Credential</th><th width="157" data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>email</code></td><td>true</td><td>When you log into Jira, you specify a username, which is your email address - enter this here.</td></tr><tr><td><code>api token</code></td><td>true</td><td>Enter your API token for Atlassian.  For information about generating API tokens, please see <a href="https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/">this Jira guide</a>.  </td></tr><tr><td><code>domain</code></td><td>true</td><td>When you log into Jira, your domain forms part of the URL - enter this here. For example, in the <code>https://patchworks.atlassian.net</code> URL, the <code>domain</code> element is <code>patchworks</code>.</td></tr></tbody></table>