Set up the Jira spoke for Jira Server

Integrate the ServiceNow instance and Jira Server using user name and password to authenticate ServiceNow requests.

Before you begin

Important:

• Starting with the Australia release, instructions for generating and using API tokens have been removed from our documentation to align with Atlassian's Acceptable Use Policy.
• As of February 15, 2024 PT, your Jira Server products reached the end of support. Starting from Jira Software 9.13 and Jira Service Management 5.13, new Jira releases support only Data Center licenses.
• End of life for impacted Data Center products will take place on March 28, 2029 at 23:59 PST. Data Center subscriptions and any associated Marketplace apps will expire on this date, making Data Center products and apps read-only. For more information, see Data Center EOL General Questions.
• Apps that collect API tokens to create individual 3LO apps don't comply with Atlassian security requirements for cloud apps and Atlassian acceptable use policy.

• Request an Integration Hub subscription.
• Activate the Jira spoke.
• Role required: admin.

Option 1: Using user name and password

Integrate the ServiceNow instance and Jira Server using user name and password to authenticate ServiceNow requests.

Before you begin

Role required: admin

Procedure

1. Navigate to All > Process Automation > Workflow Studio.
2. Click the Integrations tab.
3. Under Connections, the Outbound connections are displayed by default.
4. Locate the Jira connection alias and click View Details.
   • To configure the default connection and credential alias record that is shipped along with the Jira spoke, click View Details.
   • To manage more than one Jira spoke connection records, you should create a new child alias record by clicking Add Connection. For more information about using multiple connections, see Supporting multiple connections.

   If you are configuring the spoke for the first time, click Configure. Otherwise, click Edit.
5. On the Connection form, fill in the fields.

   Field	Description
   Connection Name	Name to uniquely identify the connection. For example, Jira Spoke OAuth basic conn.
   Connection URL	URL of your Jira instance in this format: https://api.atlassian.com/ex/jira/{cloud-id}/. Replace {cloud-id} with value of the Cloud ID you had obtained previously.
   Scopes	By default, these scopes are provided read:jira-work, read:jira-user, write:jira-work, manage:jira-project, manage:jira-configuration, manage:jira-webhook, manage:jira-data-provider, delete:sprint:jira-software, read:sprint:jira-software, write:sprint:jira-software, read:board-scope:jira-software, read:project:jira, read:jql:jira, read:issue-details:jira, read:me, read:account, offline_access. You can modify the scopes as per your requirement.

   

6. Click Create Connection.

What to do next

Select the server type in the connection record.

1. Navigate to Integration Hub > Connection & Credential Aliases.
2. Open the Jira record.
3. In the Connections tab, open the active connection record.
4. In the Attributes tab, verify that the value of server_type is set to server.

Option 2: Using API Token (does not comply with Atlassian security requirements)

Integrate the ServiceNow instance and Jira Server using API Token to authenticate ServiceNow requests.

Before you begin

Important:

Apps that collect API tokens to create individual 3LO apps don't comply with Atlassian security requirements for cloud apps and Atlassian acceptable use policy.

Role required: admin

Generate a personal access token

Generate a personal access token from the Jira Server instance.

Before you begin

• Access to Jira Server instance.
• Role required: admin

Procedure

1. Log in to the Jira Server instance as an admin.
2. Click the user profile icon and click Profile.
3. Under Personal Access Tokens, click Create token.
4. On the Create a personal access token form, fill in the required values.
   The value of personal access token is generated and displayed. Copy this value for later use.

Create a credential record for the Jira spoke

Create an API key credential record to authenticate the requests from ServiceNow.

Before you begin

Role required: admin

Procedure

1. Navigate to All > Integration Hub > Connection & Credential Aliases > Credentials.
2. Click New.
   The system displays the message, What type of Credentials would you like to create?
3. Select API Key Credentials.
4. On the form, fill these values.

   Field	Description
   Name	Name to identify the credential record. For example, Jira Server API Token Cred.
   API Key	Enter value in this format: Bearer <Personal Access Token>. <Personal Access Token> is the value of personal access token you had created in the Jira system dashboard.

5. Click Submit.

Create a connection record for the Jira spoke

Create a connection record for the Jira account. The connection and credential alias uses this connection to perform actions in Jira.

Before you begin

Role required: admin

Procedure

1. Navigate to All > Connections & Credentials > Connection & Credential Aliases.
2. Open the alias record for Jira that shipped with the spoke.
3. On the Connections tab, click New.
   The system displays a blank HTTP(s) Connection form.
4. Enter these values and click Submit.

   Field	Value required
   Name	Enter any name to uniquely identify the connection record. For example, enter Jira Server API Token Connection.
   Credential	Select the Credential record created for Jira. For example, select Jira Server API Token Cred.
   Connection URL	Enter the URL of your Jira Server instance.

5. In the Attributes related list, provide these values.
   1. Enter the value 2 for api_version.
   2. Enter the value server for server_type.
   
6. Click Submit.