Integrate JIRA Cloud with Zephyr using OAuth

Steps to Integrate JIRA Cloud with Zephyr using OAuth:

Procedure:

In order to integrate JIRA Cloud with Zephyr using OAuth, please use the following steps:

1. Configure your client application as an OAuth consumer.

  • In JIRA, the OAuth consumers are represented by application links. Application links use OAuth with RSA-SHA1 signing for authentication. This uses a private key to sign requests rather than using the OAuth token secret/consumer secret.
  • In the following steps, we'll be generating an RSA public and private key pair and then creating a new application link in JIRA that uses the keys.

Generate an RSA public and private key pair:

a. In the terminal, run the following openssl commands.

Generating Certificates
openssl genrsa -out jira_privatekey.pem 1024
openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365
openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8
openssl x509 -pubkey -noout -in jira_publickey.cer  > jira_publickey.pem

2. Configure the client application as a consumer in JIRA by using the application links.

  • In JIRA, navigate to the cog wheel icon → go the the Applications section → Navigate to the Application links page

Now use the public key .PEM file

3. Make some changes in your Zephyr instance.

  • Log into your Zephyr instance → go to the Administration section → Navigate to the Defect Tracking → Set the Defect Tracking with the admin credentials of JIRA.
  • The user must select the 'OAuth option' and then click on the new dialog box that will appear to configure the save their authentication details.
  • The OAuth details provide the following fields:
    • Name
    • JIRA URL
    • Consumer Key Name (Should be the same as the above provided in JIRA)
    • Consumer Private Key (The private key should be of type Use_privatekey.pcks8)

  • Once the user saves the details above, the following pop-up with be displayed.

  • Once you click 'Confirm' users may receive the following pop-up being displayed.

  • Click on the 'Authorize URL' link within the pop-up. A new window/tab will be opened prompting the user to allow and copy the Verification Code. Once copied, it can be entered into the pop-up within Zephyr and then the user can save it.