Connect to Jira Cloud

qTest offers a seamless connection between qTest SaaS and your Jira Cloud instance. There are two ways to establish this connection: using an API token and using an OAuth token.

This article will walk you through how to set up and configure this connection using both methods.

For information about the permissions needed to set up and configure a Cloud connection, refer to Which Jira Permissions Are Required to Set Up a Connection?

Prerequisite Information

Before configuring your connection, you must first install the free Jira Integration: qTest Enterprise add-on from the Atlassian Marketplace.

Configure Jira Cloud with the API Token

Create a New Jira Cloud Connection with the API Token Video

Watch in full screen for best picture quality.

Create a New Jira Cloud Connection with the API Token

Follow these steps to configure a connection between Jira Cloud and qTest using the API token.

  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. Select Add Jira Connection. The Add Jira Connection page is displayed.

  5. Enter information in the fields as described below:

    • Connection Name: Enter a name that represents your Jira instance.

    • Server URL: Enter the URL of your Jira instance.

    • Web URL: This field is only needed when setting up the connection between qTest Manager and Jira Server.

    • Username: Enter a Jira Global Admin username in this field. A global administrator in Jira is the same as a site administrator. For information on setting up Jira administrator permissions, refer to Manage Jira Global Permissions.

    • Password or Token: A connection can be established using a Jira Token or the Jira username/password of a Jira Global Admin. However, Atlassian is deprecating the username/password authentication option on December 1, 2018. For more information, refer to the following Atlassian Announcement: Deprecation Notice.

  6. After entering the Jira connection details, select Test Jira Connection.

    If the connection between qTest Manager and Jira is successful, the following message is displayed: "Connected to the server successfully."
  7. Select Save and Configure.

The Configure Connection page displays. From this screen, you can both configure Defect integration with Jira and import requirements from Jira.

Edit an Existing Jira Cloud Connection to use the API Token

If you are editing an existing integration, connection follow these instructions:

  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, and select the blue hyperlink for 'Instructions to create an API token' which redirects you to the Atlassian instructions.

  6. Once you retrieve the API Token, enter it in the Password or Token field.

  7. Select the Test Jira Connection icon.

  8. When the connection is tested, you can select Save and Configure.

The Configure Connection page displays. From this screen, you can both configure Defect integration with Jira and import Requirements from Jira.

Configure Jira Cloud with OAuth Token

Configure Jira Cloud Integration with OAuth Token Video

Watch in full screen for best picture quality.

Configure Jira Cloud to Use OAuth

The following procedure is an alternative way to allow qTest Manager and the Jira cloud application to connect.

qTest provides a default private key, but as of Manager 9.1 you have the option to upload your own Private Key. You will upload your private key in the Security tab of Site Administration before connecting with Jira OAuth described below.

  1. From your Jira instance, select Jira settings in the left navigation pane.

  2. The navigation pane updates, and select Applications.

  3. The navigation pane updates again, and select Applications links in the Integrations section of the navigation pane.

  4. The Configure Application Links page loads.

  5. To create a new application link, enter your qTest Manager instance’s URL in the text field and select the Create new link icon.

  1. The Create link window displays. Under Application type, select Atlassian product.

  2. Make sure you have the correct URL for the qTest instance you are connecting in the Application URL field before you select Continue.

  3. When Configure Application URL window loads, select Continue. If you receive an error message, as seen in the screenshot below, select Continue a second time and you will be directed to the next screen.

  1. After the link is created, the Link applications pop-up opens.

  2. Enter a name in the Application Name field.

  3. The Application Type will default to Generic Application. Do not change this.

  4. Select Continue (as no other fields are required for connection on this pop-up).

  5. A 'Processing' message will appear, and once completed you will be sent back to the Configure Application links screen and receive an "Application Link your application name here> created successfully" message.

  6. Locate the application you just created, and in the Action column, select the pencil icon to edit.

  7. The Configure application pop-up opens and select the Incoming Authentication tab.

  8. In the Incoming Authentication tab, and enter the following values in the required fields:

  • Consumer Key: qTest

  • Consumer Name: hardcoded-consumer

  • Public Key:

    Copy 
    MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxZDzGUGk6rElyPm0iOua0lWg84nOlhQN1gmTFTIu5WFyQFHZF6OA4HX7xATttQZ6N21yKMakuNdRvEudyN/coUqe89r3Ae+rkEIn4tCxGpJWX205xVF3Cgsn8ICj6dLUFQPiWXouoZ7HG0sPKhCLXXOvUXmekivtyx4bxVFD9Zy4SQ7IHTx0V0pZYGc6r1gF0LqRmGVQDaQSbivigH4mlVwoAO9Tfccf+V00hYuSvntU+B1ZygMw2rAFLezJmnftTxPuehqWu9xS5NVsPsWgBL7LOi3oY8lhzOYjbMKDWM6zUtpOmWJA52cVJW6zwxCxE28/592IARxlJcq14tjwYwIDAQAB
You will need to scroll to Save, and then close the pop-up.

(Optional) If you want to use your own private key, you will need to update your Jira configuration to account for the new private key you uploaded in the Security tab of Site Administration in qTest.

Existing OAuth users will need to complete the following if moving to the private key option:

  1. Delete the current Incoming Authentication configuration in Jira.

  2. Re-enter the Consumer Key, Consumer Name, and Public Key referenced above.

  3. Save.

Create a New Jira Cloud Connection-OAuth Token

If you are creating a NEW integration connection follow these instructions. If you are editing an existing Jira integration connection, skip this section and read the "Edit an Existing Jira Cloud Connection to Use OAuth Token" section.

To create a new connection, follow these steps:

  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. Select Add Connection. The Add Jira Connection page displays.

  5. Enter the Connection Name and Server URL of your Jira instance.

    Server URL is the base URL of your Jira instance and is found in your Jira System Settings.

  6. Select the Use Jira OAuth hyperlink and qTest will create an authorization URL.

  7. Select the Authorize URL hyperlink and select Allow on the Welcome to Jira pop-up.

  8. An 'Access Approved' message will display and you will need to obtain the verification code from the text on the webpage.

  9. Enter the Verification Code and select Submit.

    If you are an existing OAuth user and want to use the private key option, you will need to reconfigure your Manager application and authorize the URL again with a new verification code.

  10. Once you submit the connection Information, select the Test Jira Connection button.

  11. Once the connection is tested, you can select Save and Configure.

The Configure Connection page displays. From this screen, you can both configure Defect integration with Jira and import Requirements from Jira.

Edit an Existing Jira Cloud Connection to Use OAuth Token

If you are editing an existing integration connection, follow these instructions:

  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, and you will select the Use Jira OAuth icon.

  6. Once you select the Use Jira OAuth hyperlink, qTest will create an authorization URL.

  7. Select the Authorize URL hyperlink and choose Allow in the Welcome to Jira pop-up.

  8. An 'Access Approved' message will display, and you will need to obtain the verification code from the text on the webpage.

  9. Enter the Verification Code and select Submit.

    If you are an existing OAuth user and want to use the private key option, you will need to reconfigure your Manager application and authorize the URL again with a new verification code.

  10. Once you submit the connection Information, select the Test Jira Connection button.

  11. Once the connection is tested, you can select Save and Configure.

The Configure Connection page displays. From this screen, you can both configure Defect integration with Jira and import Requirements from Jira.