Skip to main content

Jira Connection: Service Account Token (Cloud only)

In this article we are describing how to setup a connection to your Jira Cloud instance via the Service Account Token

Prerequisites

  • Jira Cloud (not Data-center)

  • Instance access, which allows to create a service accounts and their tokens

Step by step instructions

  1. On your Jira instance, go to Settings -> User management

  2. In the menu on the left navigate to Directory -> Service accounts

  3. Create a new service account

    1. Name: piplanning.io (something which identifies piplanning.io)

    2. App role: Jira with the Role "User"

    3. Groups: Will be automatically filled when you select the Role

  4. Select the service account (if not already)

  5. Click on "Create credentials"

    1. API Token

    2. Expires: Make it expire in a year, or according to your internal policies

    3. Search and then select (checkbox on the left) the following scopes:

      1. Platform API:
        1. read:jira-user
        2. read:jira-work
        3. write:jira-work
        4. manage:jira-project

      2. Agile/Software API:
        5. read:board-scope:jira-software
        6. read:board-scope.admin:jira-software
        7. write:board-scope:jira-software
        8. read:sprint:jira-software
        9. write:sprint:jira-software
        10. read:project:jira
        11. read:issue-details:jira
        12. read:jql:jira
        13. read:dev-info:jira

    4. Copy the token

  6. In piplanning.io create/edit your Jira connection

    1. Select "Cloud Service Account Token"

    2. Paste your token into the API Token field

Did this answer your question?