How Do I Connect with JIRA?

Updated 2 months ago by Jaala

Overview

Below is a guide on how to connect your JIRA account to GitPrime, which allows you to simultaneously review Repo, Pull Request and JIRA ticket data. When connecting to your JIRA account for the first time, please keep in mind that all your JIRA projects and JIRA users will be imported. 

If your Jira account is behind a firewall, you will need to complete the following before connecting to GitPrime. 

  1. Whitelist our IP addresses over port 443
  2. Valid SSL certificate that uses a public certificate authority (CA)
  3. Public DNS resolution 
We strongly recommend you use a service account to create this Integration. Please see this help document for instructions to create a service account and read more about why service accounts are important here.

How to Connect with JIRA

Sometimes browser add-ons can interfere with this connection. If you plan on connecting your Jira account via OAuth we recommend opening GitPrime in an incognito window to setup this Integration.

Step 1:Starting on your GitPrime Home page go to the left navigation bar. At the bottom go to Settings then select Integrations

Step 2: On the Integrations page, Click on Add Integration.

Step 3: On the following page select JIRA from the Integration Provider list and click Next.

Step 4: You can choose one of two ways to connect your JIRA instance. Choose the connection that works best for your Organization. 

A.) OAuth - Selecting this option you will be establishing a connection via an Application Link.

B.) Access Token - Selecting this option you will be establishing a connection via an Access Token.

C.) Username/Password - Selecting this option you will be establishing a connection using your JIRA credentials. 

Jira has begun deprecating username and password authentication. We strongly suggest you connect to Jira via OAuth or Access Token.

OAuth

Step 1: Paste the Base URL from your Jira account. It will look something like: 

  • “https://[your company].atlassian.net”

Then click Get KeyPair.

Step 2: If the test is successful, you will be provided with credentials you need for your Application Link in JIRA. 

Step 3: The button under the first step will take you to the page in JIRA you will need for the next steps. If you are prompted to log in, please do so with administration credentials.

Step 4: Create a new link to GitPrime with the URL https://jira.gitprime.com

Step 5: An advisory box will appear.  This is expected, please confirm the URL is accurate and click Continue.

Step 6: Continuing in JIRA, enter ONLY “GitPrime” into the Application Name box. Application Type will default to Generic Application. Leave it as Generic Application. Then check the box Create incoming link, and click Continue. DO NOT POPULATE ANY OTHER FIELDS.

Step 7: This will take you to another modal in JIRA that will ask you to enter the Consumer Key, Consumer Name, and Public Key provided by GitPrime.  

All of this information can be found on the modal we have been using to connect GitPrime to JIRA.

Step 8: Once you've entered the Consumer Key, Consumer Name, and Public Key click Continue.

Step 9: Clicking Continue establishes the Application Link in JIRA. You will see the Application Link added to the list.

Before proceeding to the next step, make sure you have pop-ups disabled on your browser. The following steps will include a pop-up that will finalize your connection to your JIRA account. If you have pop-ups blocked, you will have to start all over.

Step 10: Back in GitPrime on the modal, click Test Connection.

Step 11: You will be lead to a JIRA authorization page. Click Allow to establish the connection on the GitPrime side to JIRA. After this is done the page will show success. Click on Next to continue to the final steps below.

Access Token

Step 1: In Jira, generate a personal access token by navigating to "Manage your Account". You can find this page by following the steps below:

A. Click on Profile from your personal settings menu

B. Click Manage your account on your Profile page.

C. Click on the Settings menu item then Create and manage API tokens.

D. On the "API tokens" page click Create API token.

E. Give your token a name and click Create.

F. Copy your token to your clipboard

Step 2: Now that you have created an access token, return to GitPrime and fill in following fields to complete your Integration then click Test Connection.

  • Email
  • Access Token (past your API token here)
  • Base URL - this will be your Jira URL

Step 3: Success! You have successfully connected your account.

Step 4: Click the blue Next button to finalize your Integration.

Final Steps

Step 1: The next page asks what services you want to integrate from JIRA. The only option here is tickets. Leave that On and click on Next.

Step 2: Enter your name for the JIRA Integration and then click Create.

Step 3: The below success message will be displayed verifying your connection is complete. GitPrime will now begin processing your ticket projects.

Step 4: Begin importing the projects you want to track in your reports by toggling the Import button to "on" for each project. By default all projects are set to import "off".

Step 5. In addition to importing your projects here, you can also perform the following action on this Integration.

A. Auto Import all project - Turning this "on" will auto import all projects and will continue to import new projects if applicable.

B. Pause all imports - This will not remove existing data, rather it will keep new data from being imported.

C. Refresh - This button will refresh all ticket projects and discover any new projects that may not be displayed already in your Project list.

D. Settings - Click Settings to pause or turn off ticket ingestion. Toggling Ticket Services to "off" will remove all data associated with this Integration. Pausing this service will pause ingestion of new data.

Step 6. You can see and manage your imported JIRA projects by going to Settings > Ticket Projects. To learn more about managing your Projects, see Managing Ticket Projects. To learn more about managing your new Integration settings, see Managing Integrations.

Want someone from our team to walk you through connecting your JIRA account? Email us at support@gitprime.com or click on the chat icon in the bottom right corner of your screen.


How did we do?