Configure OAuth 2.0 Connection

Owned by Govind Drolia
Last updated: Oct 10, 2024 by Dominik Trygar
5 min read

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-administration-guides/system-setup/jira-integration/setting-up-jira-integration/configure-oauth-2-0-connection.html

About

You use OAuth 2 authentication when connecting to the Jira Server / Data Center(DC). The authentication type OAuth 2.0 is not supported for Jira Cloud and RabbitMQ deployment.

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

This topic enlists the steps to configure OAuth2 Connection:

Starting with the release of 8.1.0, RabbitMQ deployment within OAuth 2.0 integration will be supported. This allows you to integrate RabbitMQ seamlessly with OAuth 2.0 for enhanced system security and authentication.​

Requirements

The procedure 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 are created Manually, the Jira user account you will use must have the following permissions:

    • Write

app-permissions.png

1. Configure an application link in the Jira Server Data Center

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 pop-up.

  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 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 saving, you will receive the OAuth 2.0 credentials 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 pop-up, 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 pop-up 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 pop-up:
    a. Click the URL specified in Step 1:

b. This will send Jira a request for the authentication code. The latter will request 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 pop-up opens Jira’s Create issue pop-up in a new tab.

Further steps

You have not yet completed the integration setup. To complete it, you must 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 automatically creates a pre-configured webhook when mapping a project in Zephyr. In this case, there is no need to perform 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 or 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