Skip to main content
Version: Next (unreleased)

Jira tokens

Each role needs a classic Jira API token with these permissions/scopes:

  • read:jira-user
  • read:jira-work
  • write:jira-work

The tokens are per-role and are sent as per-request Basic authentication; there is no login session to share. A token always belongs to the account that created it, so create each one while signed in as that role's user.

See Creating Jira tokens.

Using a single account? Skip Account setup and follow Token setup once, signed in as yourself.

Multiple (3) additional accounts After adding the users, go to your mailbox. You should have three invitation emails:

Three Jira invitation emails in the inbox, one per role

Repeat the steps below for each of them.

Account setup​

  1. Open the invitation email and click Accept invite.

  2. You're redirected to the email verification screen.

    The Atlassian email verification screen asking for a code

  3. Go back to your mailbox, copy the verification code, and paste it into the verification field.

    The verification email containing the code

  4. Fill in the name and password in the post-setup form. Make the full name match the role, e.g. Jira Task Executor, so the board shows which role did what.

    The post-setup form with full name and password fields

Token setup​

  1. You might be redirected to an onboarding screen. It doesn't matter what you select there. Once you reach the boards list, open the token page: id.atlassian.com/manage-profile/security/api-tokens.

  2. You land on an email verification screen.

    The verification screen shown before managing API tokens

  3. Go to your mailbox and copy the code into the verification field. You then reach the API tokens screen.

    The verification email for API token access

  4. Click Create API token with scopes.

    The API tokens screen

    Naming the new API token

  5. On the app selection screen, select Jira only.

    The app selection screen with Jira selected

  6. Set the scope type filter to Classic, then find and select each of the three permissions: read:jira-user, read:jira-work and write:jira-work.

    Selecting the read scope

    Selecting the read scope

    Selecting the write scope

    With all three selected, the review screen looks like this. Click Create token.

    The review screen listing the three selected scopes

  7. Copy the token and store it locally together with the user's email. Both go into .jst/jira-sdlc-tools.local.env (see Fill .jst/jira-sdlc-tools.local.env). Copy it now: Atlassian only shows it once.

    The created token with its copy button

  8. Confirm the token was created:

    1. Go to id.atlassian.com/manage-profile/security/api-tokens.

      The API tokens list showing the newly created token

    2. Check that the token you just created is listed.

    3. Confirm it has all three required scopes: read:jira-user, read:jira-work and write:jira-work.

      The token's details listing its three scopes