It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Configuring a Jira Connector with a Cloud-Based Jira Instance and Oauth Authentication

Below are some tips on configuring a Jira Align Connector to communicate with a cloud-based instance of Jira.  

To configure the connector:

BASIC INFORMATION 

BEGIN THIS PROCESS ON JIRA ALIGN

Log in to Jira Align as a Super Admin and Navigate to Administration > Jira Settings

On the Connection Management Page, Locate and select your Jira Connector in the upper right of the page and Click "Jira Connectors"

Screen Shot 2019-11-27 at 1.24.48 PM.png

A Manage Jira Connectors dialog appears.

Populate the fields with the following information

Jira Link - This is the Base URL of your Jira Cloud Instance with "/browse/{external}" appended to it.  For example:

https://actest.atlassian.net/browse/{external}

Name - This can be any name you want

Admins - You can allow certain users to be able to see and manage the connector settings. If this field is left blank, any users with access to the Jira Settings page will be able to manage the connector settings. However, if one or more user is selected in this field, only they will be able to manage them. This can be left blank during initial setup.

Jira API URL - This is the base URL of your Jira Cloud instance, for example:

https://actest.atlassian.net

AUTHENTICATION

Authentication Type - Select Oauth 1.0

OAuth Consumer Key  - type a consumer key of your preference, for example, "AgileCraftJIRA" (or whatever you like)
Note: Do not use spaces!!

Click Save.

Click Generate New Key.  This will generate a long string of characters for the key. 

MOVE TO YOUR JIRA INSTANCE FOR THE NEXT STEPS

 

Sign in to your Jira instance as an administrator.

Choose the Jira icon then click Jira settings > Products. Select Application Links in the left menu.

Enter the URL of the application you want to link to.  This is your Jira Align URL.  Click Create new link.

Screen Shot 2019-11-27 at 12.28.57 PM.png


In the Link Applications dialog box, type an application name of your preference.  This can be anything you want.   Make sure Generic Application is selected for the Application Type.  Click Continue.

NOTE - Only fill out these two fields!  If just one of the other fields are populated, then all fields become required and the attempt to establish the link will fail.


Screen Shot 2019-11-27 at 12.35.21 PM.png

 

Congratulations!  The link is created. Now you need to configure it.

 

While still on the Jira Application Links Page, click the pencil icon next to the link you  just created and click Incoming Authentication.


In the Consumer Key box, type the consumer key you created in Jira Align above.  In our example we used "AgileCraftJIRA"


Type in a consumer name of your preference. This can be anything you want.


Screen Shot 2019-11-27 at 12.36.32 PM.png

 

Scroll down and look for the Public Key box. 

Switch back to your Jira Align instance's Jira Settings and copy the public key you generated when clicking on Generate New Key earlier in Jira Align. 

Paste this key into the Public Key box on Jira.  

After entering the Consumer Key, Consumer Name, and Public Key, click the Save button.  Note that you may need to scroll down a bit to see the Save button!

 

RETURN TO YOUR JIRA ALIGN INSTANCE FOR THE NEXT STEPS


Go back to the Manage Jira Connectors dialog and click Authorize Jira OAuth access. Wait for the Jira connector to run.  This will run even if the connector is deactivated.

Click Request Jira for access.

A page for the Jira instance should open in a new tab.  Click the Allow button and then close the page that appears.

Click Save on the Jira Align Connector Setup dialog.

If the connector is not activated yet, click  the "Activate" button.

Below is a sample screenshot of what a working connector looks like when everything is set up:

Screen Shot 2019-11-27 at 12.16.36 PM.png

Further Reading:

https://agilecrafthelp.zendesk.com/hc/en-us/articles/115000088453-10X-Jira-Integration-Setup#authenticationtypes

 

 

7 comments

Robin Rotman Atlassian Team Dec 02, 2019

@Kent Baxley ++++++ :)

Don Miller Atlassian Team Apr 29, 2020

When you have connected to Jira Cloud, have your Jira Align users update their Atlassian IDs before turning on Jira integration: 

https://community.atlassian.com/t5/Jira-Align-articles/Update-Atlassian-ID-for-Jira-Cloud-users-when-integrating-with/ba-p/1365067#M389

Tarun Sapra Atlassian Team Jun 17, 2020

As @Don Miller has already shared about the fact that you should sign-in to Jira using the service account during the integration setup. Another thing to remember here is that if the customer is using SSO then it should be made sure that the Jira service account credentials are also registered with SSO as it will be required when logging in for the first time at the time of integration setup.

Like Richard Wilson likes this

make sure that 

browse/{external} is lower case.  This is important when you click on the Link to Jira button to make sure that it renders correctly. 

@Don Miller If the client does not want to make its ID public to all for security and privacy concerns what do you suggest as a workaround. 

I have synchronised users first before adding their email manually only to the users that need to work in Jira Align. Is there a downside for not making this public for non-Jira Align users. 

Don Miller Atlassian Team Jul 04, 2020

@Richard Wilson If non-Jira Align users are leveraging other applications that integrate with Jira via user e-mail addresses, they will face the same issue.

Your workaround is correct.  Jira Align Admins can update email addresses for any users that come from Jira into Jira Align with invalid email addresses.

Comment

Log in or Sign up to comment
TAGS
Community showcase
Published in Jira Align

Virtual/Remote PI Planning Best Practices and FAQ Table of Contents

Due to recent challenges of most companies having to move to virtual and remote PI planning events, the Jira Align Solutions Architects wanted to start to capture some best practices and FAQ Table of...

3,052 views 3 31
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you