Authorize with API token

Owned by
Rosen Marinkov
Last updated: May 21, 2024 by
Julver Petrova (Deactivated)
3 min read

On this page:

API token for deployments between Jira Cloud sites

API tokens in Atlassian's ecosystem allow you to authenticate to Atlassian cloud apps like Jira Cloud, Confluence, Bitbucket, Fisheye, Crucible, etc. With the token, you:

  • bypass two-step verification and SSO, and

  • retrieve data from the cloud sites through REST APIs.

Learn about API token controls from Atlassian's documentation.

Why you need an API token with CMJ Cloud

CMJ Cloud uses the API token to authorize you to source and target Jira Cloud sites when deploying configuration. To create a configuration deployment in CMJ Cloud, you must provide your Atlassian account's API token.

Benefits of using API tokens

With API tokens, CMJ Cloud doesn't need your username and password to authorize you when communicating with Jira Cloud sites.

This approach allows CMJ Cloud to securely use the Jira Cloud services without requiring or storing user credentials.

How to create and manage API tokens from your Atlassian account

You can create, view, and revoke an API token from your Atlassian account. Find more details about creating an API token in the How to get an API token section below.

You can also learn how to manage API tokens from Atlassian's documentation.

Provide an API token in CMJ Cloud

  1. Log in as a user with the Site or Organization admin permissions to your Jira Cloud site.

  2. Choose the cog icon at the top right corner of the screen, then choose Apps from the menu. 

  3. Navigate to the Configuration Manager section from the left-side menu.

  4. Navigate to Settings > Apps > Configuration Manager > Authorization.

  5. Provide an API token for your Atlassian account.

  6. Click Save token to store the token.

  7. You'll see a message indicating the API token has been stored.

You're all set to start deployments to Jira Cloud sites on the Configuration Deployment page.

Can I provide an API token without having Site or Organization admin permissions?

You can provide an API token without Site or Org admin permissions, but you won't be able to use CMJ Cloud's features.

CMJ Cloud requires Site or Org admin permissions to deploy configurations between Jira Cloud sites.

How to get an API token

You can get an API token from your Atlassian account settings at https://id.atlassian.com/manage.

Create an API token

  1. Log in to your Atlassian account https://id.atlassian.com/manage/api-tokens.

  2. Click Create API token.

  3. Choose a short and memorable label for your token from the dialog and click Create.

  4. Click Copy to clipboard, then paste the token and save it:

Additional Atlassian resources