Configure OAuth 2.0 Connection

Owned by Govind Drolia
Last updated: Feb 01, 2024 by Anubhuti Shrivastava
5 min read

About

You use OAuth 2 authentication when connecting to the Jira Server / Data Center(DC). For Jira Cloud, this is not a supported authentication type.

In Jira, external OAuth 2 Client ID and Client secret are represented by application links.

This topic enlists the steps to configure OAuth2 Connection:

Requirements

The procedure that will be described below requires you to connect to Jira at some step.

  • If webhooks will be created automatically, the Jira user account you will use must have the following permissions:

    • Admin

    • System admin

  • If webhooks will be created Manually, the Jira user account you will use must have the following permissions:

    • Write

app-permissions.png

You configure an application link to an External application using OAuth2.

 

  1. In Jira, go to ⚙ > Application > Application links (under Integrations):

jira-administration.png

  1. Click the Create New link.

  2. Select External application.

  3. Under External application select Direction Incoming

  1. Click Continue in the subsequent confirmation dialog.

  2. Now you need to configure the link properties:

  • Name*: Enter some name into the Name box, for example, Zephyr Ent.

  • Redirect URL* :Enter the URL into the Redirect URL* URL should be in the format of https://{ZephyrHostName}/flex/services/rest/v3/oAuth2/callbackUrl

  • Permission*: The procedure that will be described below requires you to connect to Jira at some step.

    • If webhooks will be created automatically, the Jira user account you will use must have the following permissions:

      • Admin

      • System admin

  • If webhooks will be created Manually, the Jira user account you will use must have the following permissions:

    • Write

  1. Credentials
    After Save you will get the credentials of the OAUTH2 that will be used in integration with Zephyr Enterprise

  • Client ID

  • Client secret

2. Configure connection in Zephyr

  1. Log in to your Zephyr Enterprise instance as a user with administrator permissions.

  2. Go to Administration > Jira Integration (under System Setup).

  3. Click + above the Jira instance list:

  1. In the subsequent dialog, specify the following values:
    - Jira URL – The URL of your Jira instance like https://{my-org}.example.com/jira.
    - Select desired authentication method - OAuth2 (preferred)

  2. Click on the Next User details form:
    Fill the form
    - Name:- Enter the unique name for this Jira
    - Client ID: - Client ID from the above step from the Jira Application link configuration
    - Client Secret: - Client Secret from the above step from the Jira Application link configuration

  1. Click Next to continue.

  1. Zephyr will show the following dialog box:

  1. If you specify the Client ID and Client Secret correctly, you will see some valid authorization URLs. Otherwise, this value will contain the error message.

    In the dialog:
    a. Click the URL specified in Step 1:

b. This will send a request for the authentication code to Jira. The latter will ask for your approval to allow Zephyr access to your Jira project. Click Allow to continue:

c. Jira will show another page with the verification code:

Copy this code to the clipboard and then switch to Zephyr and paste it into the Step 2 box:

Click Next.

  1. Zephyr will run some diagnostics and will report the results:

Click Done. You will see the newly created connection in the list of connections:

Switch the Create defects in Jira toggle on to allow creating issues directly in Jira. If the toggle is on, clicking Next in Zephyr’s File New Defect dialog opens Jira’s Create issue dialog in a new tab.

  • The token will be expired in 1 hour if the user is not logged in. User has to re-authenticate the Jira by providing the new verification code.

Further steps

You have not yet completed the integration setup. To complete it, you need to map your Zephyr project to a Jira project. Follow this link for details:

Next step: Configure your Zephyr project 

Note about webhooks

Webhooks are an essential part of Zephyr integration with Jira. They are used to synchronize Zephyr and Jira requirements and information about defects.

Webhooks can be created in two ways:

  • Zephyr creates a pre-configured webhook automatically when you are mapping a project in Zephyr. In this case, there is no need to perform any additional actions, but you need to have a Jira account with special permissions (for example, Browse Projects). You can view the created webhook in Jira settings: go to > System (under Jira Settings) > Webhooks (under Advanced).

    Don’t delete this webhook, and don’t change its properties. It has all the needed settings enabled. Later, you can update the webhook, if needed.

  • You, as an administrator, can create and manage webhooks manually. This can be useful if you do not have (or do not want to create) a Jira service account with permissions required for automatic webhook management.

See Also

Jira Integration