Jira and Jira Align Integration: Creating an API Service Account

The Jira and Jira Align Integration functions using an API Service Account.  This will be an account created in Jira for the purpose of syncing data between the two applications.  

Permissions:

The Jira and Jira Align Integration API Service Account will require the following permissions on all integrated Projects.

Jira Server and Data Center:

image.png

Jira Cloud:

image2.png

Authorization:

The Jira and Jira Align Integration API Service Account can access Jira via Basic Authentication for Jira Server and Data Center, API Token for Jira Cloud, and OAuth 1.0 for all three.  The account who's credentials or API token are entered into the Jira Align UI will serve as the API Service Account.

image.png

 

The account that is logged into Jira when allowing an OAuth handshake will serve as the API Service account.  More information on configuring OAuth between Jira and Jira Align can be found here:

https://community.atlassian.com/t5/Jira-Align-articles/Configuring-a-Jira-Connector-with-a-Cloud-Based-Jira-Instance/ba-p/1238816

 

image.png

Updates:

Updates made by the API Service Account inside of Jira will be reflected in the Jira UI as made by the API Service Account.  Updates made by the API Service Account inside of Jira Align will be reflected in the Jira Align Audit Logs as being made by an External System.  To view which user made the update in each application you can use the "View in Jira" button in Jira Align and Web Links in Jira to view cross application Audit Logs and Histories.

image.png

 

image.png

 

Please see Creating a Jira Service Account with Groups and Permission Schemes for Jira Align to see how to create a Group for your Jira Service Account.

 

 

2 comments

Don Miller
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
February 13, 2020

A Jira Align Super Admin can initiate the OAuth authentication but the person who allows the OAuth handshake on the Jira side via Application Links should be logged into Jira as a Service Account.

For a related great article on the steps involved when using Cloud Jira, check out: 

https://community.atlassian.com/t5/Jira-Align-articles/Configuring-a-Jira-Connector-with-a-Cloud-Based-Jira-Instance/ba-p/1238816

Like # people like this
Don Miller
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
March 17, 2020

You can follow these steps to re-authenticate if you have previously created the Jira Application Link while a Jira Admin and people are wondering why you are creating so many issues in their project.

When you are done, it makes sense to validate that Issues are syncing from and to Jira Align.  If you don't see issues flowing, first check any filters in your view, then check Admin>Jira Settings>View Logs>Jira API in Jira Align.  You may have an issue with how your Jira project is configured, for example with the reporter/assignee field:

https://community.atlassian.com/t5/Jira-Align-articles/Jira-Connector-Feature-Sync-Failure-quot-reporter-cannot-be-set/ba-p/1285263

Like # people like this

Comment

Log in or Sign up to comment
TAGS
AUG Leaders

Atlassian Community Events