Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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

...

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

    • Write

...

  1. Click the Create New link.

  2. Select External application.

  3. Under External application, select Direction Incoming.

...

  1. Click Continue in the subsequent confirmation dialogpop-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 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 saving, you will get receive the credentials of the OAUTH2 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 dialogpop-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. Zephyr will show the following dialog 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 dialogpop-up:
    a. Click the URL specified in Step 1:

...

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

...

Info

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 pop-up opens Jira’s Create issue dialog pop-up in a new tab.

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

...

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

...

Webhooks can be created in two ways:

  • Zephyr automatically 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).

    (warning) Don’t delete this webhook , and don’t 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.

...