Create a Jira Connection Profile

JFrog Security Documentation

ft:sourceType
Paligo

Connect Jira to Xray through the Xray interface using one of the supported authentication methods. Navigate to Administration > Xray Security & Compliance > Integrations > Jira Integration and select New Jira Integration.

JFrog Cloud New Interface (Beta)

On the taskbar, click 176260854.png (Platform Configurations), and select Xray Settings > Integrations. To learn more, click here.JFrog Platform New UI (Beta) Quick Start Guide

Xray supports three authentication methods:

  • OAuth1

  • OAuth2

  • Basic Auth

Xray Self Hosted

Xray Cloud

Jira On-Prem
  • Basic Auth

  • OAuth1

  • Basic Auth

  • OAuth1

Note: This configuration is not recommended, as it would require allowing inbound connections to your local Jira instance.

Jira Cloud
  • Basic Auth

  • OAuth2

  • Basic Auth

  • OAuth2

Follow the steps depending on the chosen authentication method.

Connect Jira to Xray Using OAuth1

In Xray:

  1. Define the following fields in the Xray Jira Integration:

    136873539.png

    Field

    Description

    Consumer Key

    The consumer key that is provided in Jira when linking applications.

    Jira server URL

    The URL of your Jira deployment.

  2. Generate a public key that you will define in your Jira.

136872784.png

In Jira:

Paste the generated Public Key you copied from the Xray interface.

136872785.png
Connect Jira to Xray Using OAuth2

In Atlassian:

Required scope permissions

read:issue-type:jira
read:issue-type.property:jira
read:project:jira
read:project.property:jira
read:user:jira
read:application-role:jira
read:avatar:jira
read:group:jira
read:issue-type-hierarchy:jira
read:project-category:jira
read:project-version:jira
read:project.component:jira
read:field:jira
read:field-configuration:jira
read:issue-meta:jira
write:issue:jira
write:comment:jira
write:comment.property:jira
write:attachment:jira
read:issue:jira
read:label:jira
offline_access
read:issue-security-level:jira
read:issue.vote:jira
read:issue.changelog:jira
read:status:jira
read:comment:jira
read:comment.property:jira
read:project-role:jira
  1. From the Developer Console of Atlassian, create an OAUTH2 Integration. Specify the callback URL as the JFrog server URL, such as:

    https://artifactory:8082/xray/api/v1/ticketing/integrations/callback
  2. In the Authentication details section, copy the Client ID and secret. You will use these in the Xray interface.

    136872786.png

In Xray: Define the following fields in the Xray Jira Integration:

136873540.png

Field

Description

Client ID

The client ID you obtained from the Atlassian OAUTH2 integration.

Client Secret

The client secret you obtained from the Atlassian OAUTH2 integration.

Connect Jira to Xray Using Basic Authentication

Define the following fields in the Xray Jira Integration:

136872787.png

Field

Description

Username

The username you use for Jira authentication.

Password

The password you use for Jira authentication.

Installation Type

Type of installation of your Jira instance, Cloud or On-Prem

Jira Server URL

URL of the Jira deployment.

Note

Ensure to test connectivity between Xray and Jira by clicking the Test Jira Connectivity button before proceeding to the next step.