Setting Up Credentials for Jira Integration

^{For more information on user permissions, click here.}

In this Article

• Username & Password Authentication (for users on Jira On-Premise Servers)
• API Token Authentication (for users on Jira Cloud Servers)
• OAuth Authentication (for users on Jira On-Premise & Cloud Servers)

Standard Authentication Methods

^{For more details on available features in other plans, click here.}

Username & Password Authentication (for users on Jira On-Premise Servers)

Users working in an on-premise server are able to use their username and password for Jira credentials, so long as the users are not being managed by a third-party tool. If you’re looking to setup an integration with Roadmunk while using an SSO provider to log into Jira, you would either need to request that your Jira admin provide you with a local username & password or check out the OAuth Authentication for Roadmunk section of this article.

API Token Authentication (for users on Jira Cloud Servers)

In June 2019, Atlassian began the deprecation of all standard authentication methods when working through integrated applications. This means that in order to connect to Roadmunk from a Jira Cloud server, you would need to generate an API token in Atlassian. 

The following guide from Atlassian can walk you through this process: API Tokens

Once generated, you can enter your Email and API Token into the credentials page of your Jira Integration setup menu to validate your credentials and begin synchronizing your data with Roadmunk.

Alternative Authentication Methods

^{For more details on available features in other plans, click here.}

OAuth Authentication (for users on Jira On-Premise & Cloud Servers)

To setup OAuth as an authentication method for your Jira Integration, you need to be on a Professional package with administrative privileges on both your account and your Jira Server. Depending on your version of Jira, the locations of certain pages may vary - feel free to reach out to support@roadmunk.com if you are unable to locate the appropriate pages in your Jira server.

To setup OAuth Authentication for Jira in Roadmunk, follow these steps: 

Enable OAuth Support in Roadmunk 

On the application, click on your Avatar in the bottom-left corner to access the Account Settings window. From there, click into the Integrations tab and select either an existing integration or create a new one. On the setup page, you will notice that there is a button for OAuth Support. To begin the setup process, make sure that this is toggled to “Enabled” - if done correctly, a Consumer Key and Public Key will appear in the modal window. 

NOTE: Enabling OAuth Support does not mean that the setup has been completed.

Setup the Application Link in Jira Server 

Once enabled on your account, you or your Jira administrator will have to setup the application link to Roadmunk in Atlassian. When logged in as a Jira admin, you can navigate to Products (also called Applications) from inside your Settings (⚙️) menu. On the navigation menu, select Application Links and begin the setup process by entering the URL https://roadmunk.com into the field shown below then select Create new link. A dialogue box will appear once Create new link is clicked - click continue in that box to begin the setup.

On the modal that appears: 

1. Set the Application Name to “Roadmunk” (or a name of your choice)
2. Ensure that Application Type is set to “Generic Application”
3. Fill in all other fields with the Consumer Key provided
4. Before continuing in the setup process, ensure that the Create Incoming Link option is checked

On the second page:

1. Enter the Consumer Key and the Public Key from Roadmunk into their respective boxes.
2. Set the Consumer Name as “Roadmunk”

Once this has been completed, Roadmunk should appear under your list of Application Links. To finalize the setup, select the Edit (✏️) icon for Roadmunk on the right-side of the line item in your linked applications and select Outgoing Authentication. Scroll down and click the Delete button, then select Delete once more in the popup that appears. The dialogue window can be closed at this point.

Setup Credentials in Roadmunk

Once this step has been completed, return to Roadmunk and navigate to the roadmap you’re looking to integrate with Jira. Click on the Integrations button in your roadmap and select either Jira Integration (for new integrations) or Modify Setup (for existing integrations). From this menu - navigate to the Credentials tab and select the Add Credentials option on the page. 

If the setup has been completed successfully in your Jira server, a small window (see above) will appear prompting you to authorize the connection. Please ensure that popup blockers are disabled or whitelisted Roadmunk, as this can prevent this window from appearing properly. Choose the Allow option and the integration should be finalized, showing the time of setup on the credential card in the setup window. Once this has been completed, you can finalize your settings on your Jira Integration modal and start working on your Jira Integrated roadmap.