Menu

qTest Scenario with OAuth Configuration Guide

Overview

As of qTest Scenario 3.3.0 OD, Scenario can now be configured to work with OAuth for either JIRA Server, or JIRA Data Center. This article outlines how to set up this configuration.

Prerequisites

  • You need to have generated a Client and Server key pair.
    • You can find the instructions below.
  • The account that setup Scenario must have the Global Administration permission.

Enable JIRA Connection in qTest to use OAuth

Before configuring Scenario to work with OAuth, your qTest and JIRA Integration should also be using OAuth. If you have already configured your JIRA Connection to use OAuth, you can proceed to the next section. If not, follow these instructions to establish your qTest and JIRA Integration with OAuth. 

Important! If your qTest Project is already using a JIRA Connection, do not create a new connection, simply edit your existing connection. 

Please note that the consumer key must be entered exactly in this format: qTest

Obtain the JIRA Access Token from within qTest

In qTest, Project Admins have the ability to view/copy the JIRA access token that is associated with JIRA integrated Projects.

  1. Navigate to the qTest project, and select the gear icon in the toolbar.
  2. Select Integration Settings. The "Configure Integrations" page displays.
  3. Select JIRA in the External Systems panel. The "Configure Integration: JIRA" page displays.
  4. In the Connection Name column, select the blue hyperlink of your JIRA Integration name
  5. The Add Jira Connection dialog opens.
  6. A "Show Password" checkbox is available and is not selected by default. Once selected, Project Admins can view and copy/paste the access token which will be used in following steps. 
    • Note: When closing the Add Connection dialogue, the checkbox resets to the default and the password/token will be hidden again.show_password_alm_connection.png

Configure Scenario to Work with OAuth

  1. From your JIRA instance, select Jira System in the Gear button () beside the account image.
  2. The Administrator page updates, select the Add-ons tab.
  3. Choose Manage add-ons at the left navigation panel.
  4. Select qTest Scenario - BDD for Jira add-on then choose Configure.
  5. The Plugin Configuration page of qTest Scenario will be loaded, then scroll down to "Basic Authentication" and "Jira OAuth" sections.
  6. Configure access token (required):  enter "oauth" in the username text box. In the password field, enter the access token that you retrieved from your qTest Project integrated with JIRA. 
    scenario_oath_qtest_token.png

  7. Configure OAuth private key (required): copy the content of the Private key file then paste to the corresponding text box. If the private key has a passphrase, then type it to the Passphrase text box. Note: we only support key decryption for pkcs8 format.
    jira_oauth_scenario-3.3.png
  8. Select Save Configuration. 
Powered by Zendesk