Connect Jira to QMetry Using OAuth

1 Introduction
2 Steps for Jira Administrator to Configure OAuth
3 Steps for End-User for Authenticating using OAuth

Introduction

OAuth 2.0 authentication is supported for Jira Cloud and Jira Server/Data Center (DC) integrations to ensure secure connectivity between QMetry and Jira.

Steps for Jira Administrator to Configure OAuth

Prerequisites for Enabling OAuth Authentication

Before enabling OAuth, ensure the following steps are completed:

Install and configure the QMetry Jira Integration App: The app must be installed and properly configured to enable OAuth authentication. Refer Install & Configure QMetry's Jira Integration App.
Active Jira Instance
Your Jira instance should be in an active status for a successful integration.
Required Permissions
- In QMetry: Users must have "Modify" rights for Integration system.
- In Jira: Users must have administrative permissions to configure the integration.

Configure Jira Cloud to Use OAuth

Watch Video Tutorial

Here are the steps to Configure OAuth 2.0 for QMetry Jira Integration:

Log in to the Atlassian Developer Console
Access the Atlassian Developer Console at Developer console with admin credentials.

Create OAuth 2.0 Integration
- Navigate to My apps and click Create.
- Select OAuth 2.0 Integration from the options.
- On the form, provide name of the integration and click Create.

Configure Authorization
- Click on the Authorization tab.
- Under Action, click Add.
- In the Callback URL field, enter {QTM-Instance-URL}/rest/integration/oauth2/callbackUrl.
  For example, https://qtm8-devcloud.qmetry.com/rest/integration/oauth2/callbackUrl
- Click Save Changes.

Set Permissions
- Go to the Permissions tab.
- Add and configure Jira API.
- Under Classic Scopes, ensure the following scopes are selected
  - read:jira-work
  - read:jira-user
  - write:jira-work

Configure Distribution
- Click on the Distribution tab and select Edit.
- Set the Distribution Status to Sharing.
- Provide Vendor Name as "QMetry"
- Set the Privacy Policy URL to: Privacy Policy & Security Statement
- Click Save Changes.

Retrieve Client ID and Client Secret
- Under Settings, locate the Authentication details section.
- Copy the Client ID and Client Secret for future use.
  Under Authentication details, copy the values of Client ID and Client Secret

Configure Data Center Jira version

Steps for Administrator to Configure OAuth

Prerequisites for Enabling OAuth Authentication

Before enabling OAuth, ensure the following steps are completed:

Install and configure the QMetry Jira Integration App: The app must be installed and properly configured to enable OAuth authentication. Refer Install & Configure QMetry's Jira Integration App
Active Jira Instance
Your Jira instance should be in an active status for a successful integration.
Required Permissions
- In QMetry: Users must have "Modify" rights for Integration system.
- In Jira: Users must have administrative permissions to configure the integration.
- For Oauth2, Jira 8.22 or above version supported

Configure Jira Server to Use OAuth

Here are the steps to configure an application link in the Jira Server Data Center:

In Jira, navigate to ⚙ > Application

Navigate to Application Links (under Integrations) and click Create Link.

In the Create Link pop-up, select External Application as the application type and set the Direction to Incoming.

Configure the link properties as follows:
- Name*: Enter a suitable name in the Name field.
- Redirect URL*: Input the following URL: {QTM-Instance-URL}/rest/integration/oauth2/callbackUrl
  Example: https://qtm8-devcloud.qmetry.com/rest/integration/oauth2/callbackUrl
- Permissions*: Ensure that Write permissions are assigned

Upon saving, you will receive the OAuth 2.0 credentials required for integration with QMetry, including:
- Client ID
- Client Secret

The rest of the content for “Configure Connection in QMetry” will remain same as cloud version. So, the follow will remain the same as above.

Configure Connection in QMetry

Log in to your QMetry instance as a user with “Modify" rights for Integration system.
Go to Integrations

You can apply filter on the Jira Instance URLs to quickly assess your Jira instance.

Enable OAuth Settings by clicking on the toggle button. This shall open the OAuth configuration pop-up window.
Enter the Client ID and Client Secret Key from Jira app settings and click on Next.

The next pop-up prompts you to connect your Jira Account. Click on the link given in Step 1

Clicking on the link will re-direct you to the callback URL that you provided under Jira Authorization. Select your Jira instance from “Use app on” and click on Accept

Accepting the access request shall generate a unique verification code.

Copy the verification code by clicking on the copy icon and paste it in the textbox in Step 2 and click on Configure

Check OAuth History

To check OAuth History

Click on the log icon as shown in the image below.

Update OAuth Configurations

To update OAuth Configurations

Click on the wrench icon as highlighted in the image below.
This shall navigate you to the Update OAuth Configuration pop-up window.
Repeat steps 4 to 8 as mentioned in the “Configure Connection in QMetry” section.

Steps for End-User for Authenticating using OAuth

To create new issues from the Issue Module or link issues from the Test Suite (Default or Detail View), the end user must complete OAuth authentication. Follow these steps to authenticate:

This completes the OAuth setup for issue creation or linking.

Select the appropriate Jira instance.
- If the selected Jira instance has OAuth authentication enabled and configured, a prompt will appear for a verification code to authenticate the Jira connection.