Skip to main content

Create Vansah API Token

How to Create a Vansah API Token

NOTE: Changes are soon coming where API tokens will be generated using Atlassian OAuth 2.0 authentication, replacing the need to manually provide Jira email address and an Atlassian API token. This delivers a more secure, simpler, and seamless authentication experience. Learn more

This will deliver:

  • Authentication using your Atlassian account with Atlassian OAuth 2.0.

  • No more manually entering your Jira email address or API token.

  • Authentication is securely handled through Atlassian Forge

Before You Begin

Creating a Vansah API Token requires a Jira API Token.

If you don't already have one, generate it first - see Atlassian's official guide: Manage API tokens for your Atlassian account

Steps

  1. Open your Jira space and go to Apps > Vansah.

  2. Click Settings > Vansah API Tokens.

  3. Click Create API Token. (Your API Connect URL is displayed on this screen)

  4. Fill in the dialog:

    • Label - a short, memorable name for the token.

    • Jira Email Address - the email tied to your Atlassian account.

    • Jira API Token - the token you generated.

    • Expiry Date - the date the token should stop working.

  5. Click Create.
    Important: Copy your token immediately. For security reasons, it is shown only once and cannot be retrieved again after you close the popup.

  6. Copy the token, then close the popup.

Troubleshooting

  • Create button is greyed out - all required fields must be filled in with a valid format.

  • Authentication fails when using the token - confirm the Jira email and Jira API token are correct and that the Jira token hasn't expired or been revoked.

  • "Token limit reached" - you can hold a maximum of 10 tokens per workspace; delete an unused one to free a slot.

Did this answer your question?