Atlassian Jira

Connecting to the Jira Repository

Standard Authentication

Required Fields:

• Location/Connection URL
  • Example Format: https://server.atlassian.net
• Username
• Password

Standard Authentication (Via AWS Secrets Manager)

This authentication method uses Standard Authentication to authenticate with Jira, with the actual credentials being retrieved from the customer’s AWS Secrets Manager. The application connects to AWS Secrets Manager to retrieve the username and password, and then uses those to authenticate with the Jira repository via Standard Authentication.  

• Note: This authentication method is only applicable for on-premises agents. It will not work for cloud agents. It is also only applicable for Jira Data Center as Jira Cloud does not support Standard Authentication. 

Prerequisites: 

• The on-premise agent should be deployed in the customer’s AWS account in the same region as the customer’s AWS Secrets Manager service that holds the Jira credentials 
• The machine hosting the agent must possess IAM Role permissions to access the necessary AWS Secrets Manager secret. 
• Customer managed keys created in AWS Key Management Service (KMS), used for encrypting secrets, should be created in the same AWS account and region

Required Fields: 

• Location/Connection URL
  • Example Format: https://server.atlassian.net 
• AWS Region 
  • The region can be determined from the AWS Secrets Manager console where the Secret is created.
  • Examples of input: us-east-1, us-west-2, etc. 
• AWS Secret Name 
  • The AWS Secret Name is the title by which the secret is created on the AWS Secrets Manager console. 
  • The username and password must be created in that secret with keys “username” and “password” respectively. 
  • Below is a screenshot of an example from the AWS Console: 

Please see the following demo video for more information:

Optional Fields:

• Xray Cloud Client ID (see details above)
• Xray Cloud Client Secret (see details above)
• Tempo Cloud API Token (see details above)

Authentication Chain: Basic Authentication with Two Way SSL

Required Fields:

• Location/Connection URL
  • Example Format: https://server.atlassian.net
• Certificate Password
• Username (for Jira)
• Password (for Jira)

Optional Fields: 

• Xray Cloud Client ID (see details above)
• Xray Cloud Client Secret (see details above)
• Tempo Cloud API Token (see details above)

Email Address and API Token Authentication (Jira Cloud only)

Required Fields:

• Location/Connection URL
  • Example Format: https://server.atlassian.net
    • URL format must begin with https
• Email Address
  • The email address used to create the API token.
• Jira API Token
  • You can learn how to create an API Token in Jira here
  • The token can only be accessed once via the Atlassian website during this setup phase. If you lose the contents of the token, you must revoke the token and start from the beginning.
  • If the token is revoked on the Atlassian website, you must create a new token and update the Viz settings.

Optional Fields:

• Xray Cloud Client ID (see details above)
• Xray Cloud Client Secret (see details above)
• Tempo Cloud API Token (see details above)

OAuth 1.0a Authentication

Required Fields:

• Location/Connection URL
  • Example Format: https://server.atlassian.net
• Consumer Key
  • The consumer key set up using the instructions below.
• Authorization User ID
  • A valid user ID with rights to the issues you'd like to flow (see Minimal User Permissions & Viz User section above).
• Authorization Password
  • The password for the Authorization User ID.
• Private Key

  • The jira_privatekey.pcks8 you created in the steps outlined below. As an example, if the private key looks like the following: 

-----BEGIN PRIVATE KEY-----
12345
abcde
-----END PRIVATE KEY-----

You only have to copy/paste the 12345abcde text. Viz will handle with the line wrap characters for you.

Optional Fields:

• Xray Cloud Client ID (see details above)
• Xray Cloud Client Secret (see details above)
• Tempo Cloud API Token (see details above)

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