Skip to content

Jira Query authentication guide

This is a step-by-step guide to acquiring Jira credentials and authorizing the Jira Query component.

The Jira Query component uses 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 Query component requires four steps:

  1. Obtain an API token from the Atlassian portal.
  2. Create a Secret in AWS Secrets Manager.
  3. Add a Secret definition to the Your projects menu.
  4. Use the API Token property drop-down in the Jira Query component to select the Jira token you have created by this process.

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 will be required in 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 an AWS Secret

Create a secret in AWS Secrets Manager. This must be in the same AWS Region as the agent selected when the project was created.

  1. Log on to the AWS console, and in the search bar search for Secrets Manager to access the Secrets page.
  2. Click Store a new secret.
  3. Select Other type of secret and enter a Key/value pair, in which:
    • Key is the Label you gave to your Atlassian API token.
    • Value is the code you copied from the token dialog.
  4. 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 Your projects.
  5. The remainder of the details are not needed, so click Next and Next again, then Store to complete the creation of the secret.

Add a secret definition

Follow the steps in Add new secret definition.

Return to Designer

  1. Return to the Jira Query component in Designer.
  2. Click into the API Token property.
  3. Select your new secret definition representing your Jira API token.
  4. Click Save.