Atlassian Jira Application Integration Setup

Getting started

BalkanID recommends creating a separate service account for the purposes of this integration, instead of using personal or employee named accounts.

Requirements:

• Jira Personal Access Token (or) Service Account API Token

• Jira Site name

Connecting via Personal Access Token (Legacy Method)

Steps to obtain credentials

1. Ensure the Service account/user you are creating an API token with has the "Site administrator" role.

2. Go to Atlassian API tokens.

3. Choose Create API token (unscoped). You can give it a name and an expiry date.

Note: When entering Jira Personal Access Token in BalkanID, it should be formatted as [e-mail]:my-api-token, using the email associated with the token.

1. Once created, copy the token and store it securely.

2. Get your site name from jira (for example, if your jira URL is https://YOUR-SITE.atlassian.net, the site name is YOUR-SITE (e.g. acme for https://acme.atlassian.net).

Connecting via Service Account Access Token

Getting credentials from Jira Cloud

The extractor supports both unscoped and scoped API tokens. You only need siteName (or orgName) and token - the extractor auto-detects which API to use.

Create API token

1. Go to Atlassian API tokens

2. Choose Create API token (unscoped) or Create API token with scopes (for least-privilege; see checklist for required scopes)

3. Copy the token and store it securely

Get your site name

From your Jira URL https://YOUR-SITE.atlassian.net, the site name is YOUR-SITE (e.g. acme for https://acme.atlassian.net).

Config format

{
  "appConfig": {
    "token": "[e-mail]:your_api_token",
    "siteName": "your-site"
  }
}

• token: EMAIL:API_TOKEN (email of the Jira user + colon + API token)

• siteName or orgName: Site subdomain from your Jira URL (they are aliases)

Required Jira permissions

The Jira user must have Browse users and groups, Administer Jira, and Browse projects.

Scopes for scoped API tokens (Read Only)

If you use Create API token with scopes, select Jira and add:

Granular scopes (recommended):

read:permission:jira
read:project:jira
read:project.property:jira
read:issue-type:jira
read:user:jira
read:application-role:jira
read:group:jira
read:avatar:jira

Classic scopes (alternative):

read:jira-work
read:jira-user
manage:jira-configuration

Scopes for scoped API tokens (Lifecycle)

read:user:jira
read:group:jira
read:avatar:jira
read:project:jira
read:project.property:jira
read:issue-type:jira
write:permission:jira
write:user.property:jira
write:group:jira
delete:group:jira
read:role:jira
delete:user.property:jira

Configuring Atlassian Jira in your BalkanID tenant

1. Login to the BalkanID application and switch to the tenant you would like to add your integration to.

2. Head to Integrations > Add Integration, select Atlassian Jira.

   

   
3. Set up the Primary Application owner (mandatory) and the Description, if any. Set up Secondary Application Owner(s), if any.

   Select the Extraction Type. From here, you can configure your application using one of the following methods:

   1. Direct integration - Provide your Jira Personal Access Token and Jira Organization Site Name obtained above to set up a direct connection with BalkanID.

   2. SCIM integration - Provide SCIM server credentials to set up a SCIM connection with BalkanID.

   3. Manual file upload - Upload Entity and Entity Relations through a .CSV file upload. Contact the team for assistance with this.

   4. Automated upload using API - You can upload data using our Bulk APIs with the help of an API key which will be provided to you. Please refer to the entity and entity relation upload docs for specific instructions on uploading your data through the API.

      

   Note: When setting up Jira Personal Access Token, format it as [e-mail]:my-api-token, using the email associated with the token. In the JIRA Site Name field, enter the site name from Jira Admin Settings under Products.

1. Click on next to move onto Optional Configuration.

2. Fill Optional configuration, if required.

   
3. Once you filled in the information, click Save. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status will read Connected and the integration Message will read Data available.