Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

Jira Align Cloud to Jira Data Center Connectivity (Quick Guide)


This article is designed to get Jira Align Cloud to Jira Data Center connectivity up and going quickly.

Looking for the Jira Cloud guide, rather than Data Center? We've got you covered, here it is.




Connector Setup

Jira Align

1) In Jira Align, click on the Administration Gear in the bottom left.

2) Click on Connectors > Jira Settings in the second column.



3) Click on the Jira Connectors button in the main pane.



4) Fill out the Jira Connector as follows:


  • Jira Link: https://<your JIRA Base URL>/browse/{external}
  • Name: Anything descriptive. This is a vanity name only.
  • Admins: Add any other Jira Align users that you want to manage this connector that are not Super Admins.
  • Jira API URL: https://<your JIRA API URL>
    • Note: If you are using a Proxy or API Gateway, this will be different from the Jira Link.
  • Authentication Type: OAuth 1.0 Authentication (highly recommended)
    • Note: If you are unable to use OAuth 1.0, you can skip the OAuth section later in this document and opt to use Basic Auth with the Jira Service Account username and password.
  • Jira OAuth Consumer Key: Anything descriptive. Remember this Consumer Key for later.
    • Note: Do not use spaces or symbols for the Consumer Key!

Additional Note: If the Service Light is gray and not green, then you'll need to contact  Jira Align Support  to activate the service before proceeding. Please include the connector type (Jira Connector) and Connector ID (Number).


5) Once the above has been filled out, click Generate New Key and copy it to your clipboard.

  • Note: Some browsers have issues copying this block of characters so you may have to try a few times to get it in the clipboard. I've also found resizing the text box and then copying helps as well.

6) Click Save at the bottom of the Connector window. We are done with Jira Align for the moment.

Next, we are going to sign into your Jira Software Data Center instance.


Jira Data Center


7) Login to Jira, click the Settings cog in the top right, and select Applications.

Note: Alternatively, you can click on any whitespace in Jira and press "." and search for Application Links. 



8) On the left column, under Integrations, click Application Links.



9) Enter the Jira Align URL ( in the field and click Create New Link.



10) Jira Server/Data Center may complain there was no response. Just click Continue.



11) Fill out the Application Name with something descriptive.



12) Click the Pencil to edit the newest application.



13) Go to Incoming Authentication and fill out the Consumer Key with the same one used in Step 4. 



14) Paste the OAuth Public Key you copied from Step 5. 



15) Scroll down and click Save.

16) Go back to the Jira Align Connector window from step 4.  

17) Click Authorize Jira OAuth Access.

Screen Shot 2020-10-13 at 10.39.35 PM.png

Note 1: If a Jira OAuth token authorization already exists, the button will display as Reauthorize Jira OAuth access. Clicking this will perform the same process of generating a fresh OAuth token.

Note 2: You will see this request go through 3 steps and will refresh several times. It will take a few minutes for this process to complete.

Screen Shot 2020-10-13 at 10.39.40 PM.png

Note 3: If you are having trouble with this step, make sure that the Consumer Key matches on both sides and contains no spaces or symbols.

In addition, check that the OAuth Public Key are an exact match on both sides.

Lastly, make sure that the Application URL configured in the Jira Application Link is correct without any typos.

See OAuth Error During Setup for more troubleshooting tips.

Note: For the next step (18) make sure you are logged into Jira Server/Data Center as the Jira Service Account in another tab of the same browser. The Jira Align connection to Jira Software will use whichever account you were signed in as. If you are signed in using your personal account, that means your name will be written on any updates pushed from Jira Align to Jira Software, instead of the name of the Service Account you created.


18) Once the OAuth access setup has completed, click Request Jira for access.

Screen Shot 2020-10-13 at 11.00.52 PM.png


19) You'll be taken to another tab asking you to allow the application to have access. Click Allow

_15.pngScreen Shot 2020-10-13 at 11.09.53 PM.png


20) The connector screen will now show Reauthorize Jira OAuth access (instead of Authorize Jira OAuth Access, or Request for Jira Access). This is how OAuth in Jira Align will look when the process is completed:

Screen Shot 2020-10-13 at 11.21.37 PM.png


21) Click Save on the bottom of the Connector window.


22) (Skip this step if you used OAuth as the authentication method instead of Basic Auth.) One final test to confirm connectivity is the Test Now button at the bottom of the Jira Connector window. You may need to scroll down to see it.

Note: This test doesn't automatically refresh so you'll need to close and reopen the connector window periodically. This test also takes a few minutes to complete.

Screen Shot 2020-10-13 at 11.15.10 PM.png

Screen Shot 2020-10-13 at 11.23.00 PM.png

Screen Shot 2020-10-13 at 11.24.55 PM.png


23) Click Activate on the bottom of the Connector window.


24) Now that you are connected, you can sync a test project. 


NOTE: For any of the authentication methods (OAuth, PAT, API Authentication/Basic Auth), if you need to change them (i.e. expired token or password), you'll need to Deactivate the connector, make the authentication update, save, and then Activate the connector. 


Additional Resources

10X Jira Integration Setup 

Creating an API Service Account 

Jira Data Center with Apigee 



Karalee Kikiros October 14, 2020

Hi @James McCulley Step 7 - what version of Jira are you using please (because that doesn't appear to be the instructions for Jira server/DC incl. the latest LTS release 8.13)? It looks like you have reused the instructions from Jira Cloud not Jira DC. Clicking the cog looks like this: 


Jira on-prems would need to click Applications > Application links

Like James McCulley likes this
James McCulley
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
October 14, 2020

Hey @Karalee Kikiros. Thanks for the comment. I was able to make the correction to the article. Nice catch!

Scottie Brimmer April 6, 2021

I get an error that Shared Secret, Request Token Url and all the others are required?

James McCulley
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
April 14, 2021

Hello @Scottie Brimmer. If you click on any of the non-required fields in step 11, you will get that error. If you just fill out the Application Name and click Continue, it should let you go through without filling out anything else. Please let me know if that fixes the issue!

Johannes Berneburg
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
August 3, 2021

Hi, at step 17 we needed Atlassian to set the connector to "Service" in order to make it work. This hint might help in the step-by-step guide above.

Otherwise, a very helpful guide :-)

Like James McCulley likes this
James McCulley
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
August 30, 2021

@Johannes Berneburg  Yes you'll need to have a green service light for the connector to work. Good call out. I will update the wording. Thanks!

Varun Nelluri January 31, 2024

Great article, One question:

We use Oauth for our jira DC and jira align integration using dedicated service account(It's AD accounts credentials are set in OKTA), if we reset the password of this service account will it break the integration ? and if yes, do we need reauthenticate again?




Log in or Sign up to comment
AUG Leaders

Atlassian Community Events