Skip to content

Jira authentication guide

This is a step-by-step guide to acquiring Jira credentials to authorize the Jira Load and 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 or Jira Query component includes four steps:

  1. Obtain an API token from the Atlassian portal.
  2. Create a secret to store the Atlassian API Token.
  3. Add a secret definition 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. Navigate to the Atlassian portal and enter valid login credentials.
  2. On the Atlassian product dashboard, click your user icon at the upper-right of the page, and then click Account Settings.
  3. On the Atlassian account page, click Security on the left sidebar.
  4. On the Security page, click Create and manage API tokens at the bottom of the API token section.
  5. On the API Tokens page, click Create API token.
  6. In the Create an API token dialog, enter a memorable and concise name for the API token in the Label field, then click Create.
  7. In the Your new API token dialog, copy the displayed code as this Atlassian API Token will be required when creating the secret.

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.

You can now close the dialog and exit the Atlassian portal.

Create a secret

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

AWS Secrets Manager

  1. Log in to the AWS account that houses your agent. This must be in the same AWS Region as the agent selected when the project 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 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 agent. This must be in the same Azure Region as the agent selected when the project 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 agent.
  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.
    • 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.

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.

Got feedback or spotted something we can improve?

We'd love to hear from you. Join the conversation in the Documentation forum!

© Copyright 2025 Matillion Ltd | Legal | Privacy Policy | Disclaimer | Modern Slavery Statement