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

# Jira authentication guide

export const maia = "Maia";

export const designer = "Designer";

This is a step-by-step guide to acquiring Jira credentials to authorize the [Jira Load](/docs/components/jira-load) and [Jira Query](/docs/components/jira-query) components.

These components use either a username and password or a username and API token for third-party authentication. This guide will only explain the username and API token method.

Authorizing the [Jira Load](/docs/components/jira-load) or [Jira Query](/docs/components/jira-query) component includes four steps:

1. [Obtain an API token](#obtain-an-api-token) from the Atlassian portal.
2. [Create a secret](#create-a-secret) to store the Atlassian API Token.
3. [Add a secret definition](/docs/guides/secrets-and-secret-definitions) to the **Your projects** menu.
4. Use the **API Token** property drop-down in the component properties to select the Jira token you have created.

***

## Obtain an API token

1. Log in to the [API tokens](https://id.atlassian.com/manage-profile/security/api-tokens) section of the Atlassian portal.
2. Follow the instructions in the Atlassian [Create an API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/#Create-an-API-token) documentation to create a new API token.

<Note>
  * Make sure to copy the API token immediately as it will only appear once.
  * When copying the token, some browsers may add a space to the end of the string. Watch out for this as it will cause the credentials to fail.
</Note>

You can now exit the Atlassian portal and return to {maia}.

***

## Create a secret

You must create a secret to store your Atlassian API Token. How this secret is stored depends on your Maia deployment model:

* In a [Full SaaS](/docs/guides/runner-overview#matillion-full-saas) deployment model, you must add a secret to the internal managed vault service that is hosted in Matillion's own AWS infrastructure. Read [Secrets and secret definitions](/docs/guides/secrets-and-secret-definitions#create-a-secret-definition-matillion-full-saas) for details.
* In a [Hybrid SaaS](/docs/guides/runner-overview#hybrid-saas) deployment model, you must add a secret to either [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) or [Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/secrets/about-secrets) in your own cloud infrastructure, as described below.
* In a Hybrid SaaS deployment model using a Maia runner for Snowflake, read [Secrets in the Maia runner for Snowflake](/docs/guides/snowflake-runner-secrets) for details of how to store the secret in a Snowflake schema.

### AWS Secrets Manager

1. Log in to the AWS account that houses your Maia runner. This must be in the same AWS Region as the runner selected when the [project](/docs/guides/projects) was created.
2. In the search bar search for **Secrets Manager** to access the **Secrets** page.
3. Click **Store a new secret**.
4. Select **Other type of secret** and create a **Key/value** pair with the following details:
   * **Key:** Enter a label you will use to identify the token.
   * **Value:** Enter the Atlassian API Token code you copied earlier.
5. Click **Next** and on the next page enter a **Secret name**. This is the name that will appear in the [Secret definitions](/docs/guides/secrets-and-secret-definitions) list in **Your projects**.
6. The remainder of the details aren't needed, so click **Next** and **Next** again, then **Store** to complete the creation of the secret.

### Azure Key Vault

1. Log in to the Azure account that houses your Maia runner. This must be in the same Azure Region as the runner selected when the [project](/docs/guides/projects) was created.
2. Click **Key vaults** and click the name of the key vault you want to reference. If there is only one, then this will be the **\[Default]** key vault configured in the runner.
3. Click **Objects** and then click **Secrets**.
4. Click **+ Generate/Import**.
5. On the **Create a secret** screen enter the following:
   * **Upload options:** Select **Manual**.
   * **Name:** Type a name for the secret. The secret name must be unique within a key vault. For more information on naming, read [Key Vault objects, identifiers, and versioning](https://learn.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#objects-identifiers-and-versioning).
   * **Secret value:** Enter the Atlassian API Token code you copied earlier.
6. Click **Create**.

***

## Add a secret definition

Follow the steps in [Secrets and secret definitions](/docs/guides/secrets-and-secret-definitions).

***

## Return to Designer

1. Return to the component properties in {designer}.
2. Click into the **API Token** property.
3. Select your new secret definition representing your Jira API token.
4. Click **Save**.