Set up the Jira spoke for Jira Cloud

  • Release version: Yokohama
  • Updated January 30, 2025
  • 16 minutes to read

    • Integrate your ServiceNow instance with the Jira Cloud instance to authenticate the requests from ServiceNow.

    Before you begin

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

    About this task

    You can set up the Jira spoke for your Jira Cloud instance using basic authentication or OAuth authentication as per your requirement.

    Option 1: Using OAuth authentication (Authorization Code grant type)

    Integrate the ServiceNow instance with your Jira account using OAuth to authenticate ServiceNow requests.

    Before you begin

    Role required: admin.

    Obtain the value of Cloud ID

    Obtain the value of Cloud ID of the Jira Cloud instance. This value is required during the configuration of the connection record in your ServiceNow instance.

    Before you begin

    Role required: admin

    Procedure

    1. Log in to Atlassian Administration as an admin.
    2. Click Select against the required organization.
    3. From the Jira Software product, click Manage product access.
      A new window is opened and the URL is in this format: https://admin.atlassian.com/s/<Cloud-ID>/apps.
    4. Copy the value of the Cloud ID for later use.

    Configure a connection for Jira spoke

    Add and configure a Jira connection to authenticate ServiceNow requests in Jira spoke.

    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 Save and Get OAuth Token.

    Option 2: Using OAuth authentication (Client Credentials grant type)

    Integrate the ServiceNow instance with your Jira account using OAuth to authenticate ServiceNow requests.

    Before you begin

    Create an application registry record

    Before you begin

    Role required: admin

    Procedure

    1. Navigate to All > System OAuth > Application Registry.
    2. Click New.
      The system displays the message What kind of OAuth application?.
    3. Select Connect to a third party OAuth Provider.
    4. On the form, fill these values.
      Field Description
      Name Name to identify the application registry record. For example, Jira Client Credentials OAuth.
      Client ID Client ID generated when the OAuth 2.0 integration was created in Atlassian Developer console.
      Client Secret Client secret generated when the OAuth 2.0 integration was created in Atlassian Developer console.
      Default Grant type Grant type used to establish the token. Select Client Credentials.
      Token URL OAuth server token endpoint. Enter: https://auth.atlassian.com/oauth/token.
      Token Revocation URL OAuth server token revocation endpoint. Enter: https://auth.atlassian.com/oauth/token.
      Active Select the check box.
    5. In the OAuth Entity Scopes tab, create these entity scope records.
      Name OAuth scope
      Classic scopes manage:jira-configuration manage:jira-project manage:jira-webhook read:jira-work read:jira-user write:jira-work
      Granular Scopes delete:sprint:jira-software read:issue-details:jira read:jql:jira read:sprint:jira-software write:sprint:jira-software read:board-scope:jira-software read:project:jira
    6. Right-click the form header and click Save.
      The record is saved and a OAuth Entity Profile record under the OAuth Entity Profiles tab.
    7. Click the OAuth Entity Profiles tab and open the default profile record.
    8. Verify these values.
      • Grant type is set to Client Credentials.
      • Scope records previously created are listed under the OAuth Entity Profile Scopes related list.
    9. Click Update.

    Create credential record for the Jira spoke

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

    Before you begin

    Role required: admin

    Procedure

    1. Navigate to All > Connections & Credentials > Credentials.
    2. Click New.
      The system displays the message What type of Credentials would you like to create?
    3. Select OAuth 2.0 Credentials.
    4. On the form, fill these values.
      Field Description
      Name Name to identify the credential record for the Jira spoke. For example, Jira client credential cred.
      OAuth Entity Profile Select the OAuth entity profile record that was created when the application registry record is configured. For more information, see Create an application registry record.
    5. Right-click the form header and click Save.
    6. Click the Get OAuth Token related link.

    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 cloud OAuth Connection.
      Credential Select the Credential record created for Jira. For example, select Jira cloud OAuth credential.
      Connection URL Enter the URL of your Jira instance in this format: https://api.atlassian.com/ex/jira/<Cloud-ID>.

      For information about obtaining the value of Cloud ID, see Obtain the value of Cloud ID.
    5. Click Submit.
      The Jira spoke is configured to use OAuth 2.0 Client Credentials via the service account.

    Option 3: Using basic authentication and API token

    Integrate the ServiceNow instance and Jira Cloud instance using an API key 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.

    About this task

    You can integrate a ServiceNow instance with multiple Jira instances. For this integration, create a connection and credential alias record and a connection record for each Jira instance.

    Generate an Atlassian account API token

    Generate an Atlassian account API token to authenticate requests for spokes associated with an Atlassian account.

    Before you begin

    Make sure you have an Atlassian account.

    Role required: Atlassian administrator credentials

    About this task

    Complete these steps from your Atlassian account. See the Atlassian Developer portal documentation for instructions on generating your API token.
    Note:
    This procedure is applicable only if you're using the Jira Cloud subscription.

    Procedure

    1. Log in to Atlassian Start as an admin.
    2. Go to your account profile photo and select Account Settings.
      Atlassian Start page with the drop down menu of the selected profile picture. Account Settings option emphasized.
    3. Go to Security.
    4. In the API token section, select Create and manage API tokens.
    5. Select API token.
    6. On the form, provide an integration name for the Label field.
    7. Select Create.
      The Create an API token modal with the Create button emphasized.
      The API token is generated.
    8. Select Copy and record the value of the API token for later use.
      Confirmation modal of Your new API token with the Copy button emphasized.

    What to do next

    Use your API token to configure the cloud connection for a Jira or Jira Service Management spoke.

    Create credential record for the Jira spoke

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

    Before you begin

    Role required: admin

    Procedure

    1. Navigate to All > Connections & Credentials > Credentials.
    2. Click New.
      The system displays the message What type of Credentials would you like to create?
    3. Select Basic Auth Credentials.
    4. On the form, fill these values.
      Field Description
      Name Name to identify the credential record for the Jira spoke. For example, Jira Cloud Basic Auth Token cred.
      User name Enter the email address of the user.
      API Key Enter the API token you generated for your Jira Cloud instance.
    5. Right-click the form header and click Save.

    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 cloud Basic Auth Token Connection.
      Credential Select the Credential record created for Jira. For example, select Jira Cloud Basic Auth Token cred.
      Connection URL Enter the URL of your Jira instance in this format: https://api.atlassian.com/ex/jira/<Cloud-ID>.

      For information about obtaining the value of Cloud ID, see Obtain the value of Cloud ID.
    5. Click Submit.
      The Jira spoke is configured to use basic credentials via the service account.

    Option 4: Using basic authentication with API token and scopes

    Integrate the ServiceNow instance and Jira Cloud instance using an API key with scopes 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.

    About this task

    You can integrate a ServiceNow instance with multiple Jira instances. For this integration, create a connection and credential alias record and a connection record for each Jira instance.

    Generate an Atlassian account API token with scopes

    Generate an Atlassian account API token with the required scopes to authenticate requests for spokes associated with an Atlassian account.

    Before you begin

    Make sure you have an Atlassian account.

    Role required: Atlassian administrator credentials

    About this task

    Complete these steps from your Atlassian account. See the Atlassian Developer portal documentation for instructions on generating your API token.
    Note:
    This procedure is applicable only if you are using the Jira Cloud subscription.

    Procedure

    1. Log in to Atlassian Start as an admin.
    2. Go to your account profile photo and select Account Settings.
      Atlassian Start page with the drop down menu of the selected profile picture. Account Settings option emphasized.
    3. Go to Security.
    4. In the API token section, select Create and manage API tokens.
    5. Click Create API token with scopes.
      Create API token with scopes.
    6. On the Name API token form, enter Name, select an expiry date for the token, and click Next.
      Provide details to create token.
    7. On the Select the app form, select Jira and click Next.
      Select the Jira app.
    8. On the Select Jira scopes form, select the required scopes and click Next.
      Select the required scopes.

      For details about scopes needed to use the required spoke actions, see Required API token scopes.

    9. Review the API token scopes and click Create token.
      Review details and create token.
      API token is generated and displayed. Copy and record the token value for later use.
      Copy the token value.

    Create credential record for the Jira spoke

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

    Before you begin

    Role required: admin

    Procedure

    1. Navigate to All > Connections & Credentials > Credentials.
    2. Click New.
      The system displays the message What type of Credentials would you like to create?
    3. Select Basic Auth Credentials.
    4. On the form, fill these values.
      Field Description
      Name Name to identify the credential record for the Jira spoke. For example, Jira Cloud Basic Auth Token Scopes cred.
      User name Enter the email address of the user.
      API Key Enter the API token you generated for your Jira Cloud instance.
    5. Right-click the form header and click Save.

    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 cloud Basic Auth Token Scope Conn.
      Credential Select the Credential record created for Jira. For example, select Jira Cloud Basic Auth Token Scopes cred.
      Connection URL Enter the URL of your Jira instance in this format: https://api.atlassian.com/ex/jira/<Cloud-ID>.

      For information about obtaining the value of Cloud ID, see Obtain the value of Cloud ID.
    5. Click Submit.
      The Jira spoke is configured to use OAuth 2.0 Client Credentials via the service account.

    Required API token scopes

    API token scopes needed to use the required spoke action are listed here.

    These scopes are needed when you set up Jira spoke for Jira Cloud using API token with scope. For more information, see Option 4: Using basic authentication with API token and scopes.

    Category Action Description Scope required (Classic) Scopes required (Granular)
    Audit Management Look up Audit Logs Stream Retrieves login activity for the AtlassianJira user subscriptions.
    Note:
    This action is supported on Jira Server 9 and earlier versions, and Jira Cloud.
    		 manage:jira-configuration read:audit-log:jira, read:user:jira
    Look up Audit Logs Stream (Server 10+) Retrieves audit log records from the Jira instance within a specified date range.
    Note:
    This action is supported on Jira Server 9 and later versions.
    		 This action is supported only on Jira Server.
    Group Management Add User to Group Adds given user to a group in Jira. manage:jira-configuration write:group:jira, read:avatar:jira, read:group:jira, read:user:jira
    Create Group Creates a group in Jira. manage:jira-configuration read:group:jira, read:user:jira, write:group:jira, read:avatar:jira
    Look up Groups Stream Retrieves all groups in the Atlassian account, including the default groups.
    Note:
    This action can be used with Jira Cloud subscription only.
    		 read:jira-user read:group:jira
    Look up Users by Group Name Stream Retrieves details of all members in an Atlassian group. manage:jira-configuration read:group:jira, read:user:jira, read:avatar:jira
    Remove Group Removes the given group from Jira. manage:jira-configuration delete:group:jira
    Remove User from Group Removes the given user from a group in Jira. manage:jira-configuration write:group:jira
    Issue Management Add Comment Adds a comment to the specified issue in Jira. write:jira-work read:comment:jira, read:comment.property:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, write:comment:jira, read:avatar:jira
    Add Watcher Adds the specified user as a watcher for the specified issue. write:jira-work write:issue.watcher:jira
    Assign Issue Assigns the issue in Jira to the user. write:jira-work write:issue:jira
    Copy Attachment Copies the required attachment associated with the ServiceNow record to the required issue in Jira. write:jira-work read:user:jira, write:attachment:jira, read:attachment:jira, read:avatar:jira
    Create Issue Creates an issue in Jira. Depending on how your organization is using Jira, an issue could represent a software bug, a project task, a help desk ticket, or more. An issue in Jira represents a task in the ServiceNow AI Platform. write:jira-work, read:jira-work write:issue:jira, write:comment:jira, write:comment.property:jira, write:attachment:jira, read:issue:jira
    Delete Attachment Deletes the required attachment in Jira. write:jira-work delete:attachment:jira
    Delete Issue Deletes an issue in Jira. write:jira-work delete:issue:jira
    Delete Watcher Deletes the user as a watcher for the specified issue. write:jira-work write:issue.watcher:jira
    Do Transition Transitions an issue in Jira from one state to another. write:jira-work write:issue:jira, write:issue.property:jira
    Look up Issue Type Statuses by Project Retrieves details of the statuses in a project. read:jira-work read:issue-status:jira, read:issue-type:jira, read:status:jira
    Look up Issue Retrieves the details for an issue. read:jira-work read:issue-meta:jira, read:issue-security-level:jira, read:issue.vote:jira, read:issue.changelog:jira, read:avatar:jira, read:issue:jira, read:status:jira, read:user:jira, read:field-configuration:jira
    Look up Issue Priorities Retrieves the list of issue priorities and details for individual issue priorities. write:jira-work, read:jira-work read:priority:jira
    Look up Issues Stream Retrieves a list of issues matching a JQL query string. read:jira-work read:issue-details:jira, read:audit-log:jira, read:avatar:jira, read:field-configuration:jira, read:issue-meta:jira
    Look up Sprint Issues Stream Retrieves the details of all issues for the given sprint. No classic scopes available. read:sprint:jira-software , read:issue-details:jira, read:jql:jira
    Look up Transitions Retrieves information about all Transitions for a given Issue ID. read:jira-work read:issue.transition:jira, read:status:jira, read:field-configuration:jira
    Look up Watchers Retrieves the list of watchers for the specified issue. read:jira-work read:issue.watcher:jira, read:user:jira, read:avatar:jira
    Update Issue Updates a set number of fields of an issue in Jira with values passed as input. write:jira-work, read:jira-work write:issue:jira
    Metadata Retrieval Get Creatable Fields (Metadata) Retrieves the list of all fields in a required Jira project. write:jira-work, read:jira-work read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
    Get Editable Fields (Metadata) Retrieves the list of all editable fields in a required Jira issue. write:jira-work, read:jira-work read:issue-meta:jira, read:field-configuration:jira
    Get Issue Types (Metadata) Retrieves the list of all issue types in a required Jira project. write:jira-work, read:jira-work read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
    Project Management Create Project Creates a project in Jira. manage:jira-configuration write:project:jira, read:project:jira
    Look up Project Retrieves details of the specified project by its ID or key. write:jira-work, read:jira-work read:issue-type: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
    Look up Projects Retrieves details of all projects.
    Note:
    This action only works for the Jira server.
    		 This action is supported only on Jira Server.
    Look up Projects Stream Retrieves details of all projects.
    Note:
    This action only works for the Jira Cloud.
    		 read:jira-work read:issue-type: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
    Look up Users Assignable to Projects Retrieves a list of users that can be assigned to issues in one or more projects. read:jira-user read:project:jira, read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira
    Sprint Management Create Sprint Creates a sprint in Jira. No classic scopes are available. read:board-scope:jira-software , read:project:jira Create Sprint - write:sprint:jira-software
    Delete Sprint Deletes a sprint in Jira. No classic scopes are available. delete:sprint:jira-software
    Look up Sprint Retrieves the details of the required sprint as a complex object. No classic scopes are available. read:sprint:jira-software
    Look up Sprints by Board Retrieves the details of all sprints in the required board. No classic scopes are available. read:sprint:jira-software
    Update Sprint Updates the details of a sprint in Jira. No classic scopes are available. write:sprint:jira-software
    Story Management Create Story Creates a story in the Jira Cloud instance. This is comparable to story in the ServiceNow Agile Development plugin. write:jira-work write:issue:jira, write:comment:jira, write:comment.property:jira, write:attachment:jira, read:issue:jira
    Look up Stories Stream Retrieves details of all stories. read:jira-work read:issue-details:jira, read:field.default-value:jira, read:field.option:jira, read:field:jira, read:group:jira
    Update Story Updates a set number of fields of a story in Jira Cloud with the provided input values. write:jira-work write:issue:jira
    User Management Create User Creates a user in Jira.
    Note:
    This action isn’t supported when OAuth 2.0 authentication is used.
    		 Scoped API token is not supported for this action.
    Look up Authenticated User Retrieves details of the authenticated user account. read:jira-user read:application-role:jira, read:group:jira, read:user:jira, read:avatar:jira
    Look up Group Memberships for User Retrieves details of all groups of an Atlassian user. read:jira-user read:group:jira
    Look up Users Stream Retrieves details of all Atlassian Jira user subscriptions.
    Note:
    This action can be used with a Jira Cloud subscription only.
    		 read:jira-user read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira
    Look up Users Stream by Name Retrieves a list of users that match the search string.
    Note:
    This action can be used with a Jira server subscription only.
    		 This action is supported only on Jira Server.
    Remove User Removes a user from Jira.
    Note:
    This action isn’t supported when OAuth 2.0 authentication is used.
    		 Scoped API token is not supported for this action.
    Utility Actions Copy Issue Attachment to Record Copies Attachment from Jira to any record in ServiceNow instance. When you use this action in a subflow, make sure that the Content URL data pill is specified in the Attachment URL field. No applicable scopes as Jira endpoint is not used in this action.
    Look up Fields Retrieves the internal name and other details of the required field label in Jira. read:jira-work read:field:jira, read:avatar:jira, read:project-category:jira, read:project:jira, read:field-configuration:jira
    Look up Issue from Comment Retrieves the details of the issue by parsing the payload for the specified comment. You can use this action in the Process Jira Webhook subflow for Jira on-prem server when only comment related information is specified without any details about the Jira issue. For example, when only comment information is specified, this action parses the payload and extracts the issue details. No applicable scopes as Jira endpoint is not used in this action.
    Look up Latest Attachment on Issue Retrieves the latest attachment for the specified issue from Jira. You can use this action in a flow or subflow for validation. For example, a subflow adds an additional attachment only when the latest attachment of an issue in Jira isn’t as the same specified attachment. read:jira-work read:issue-meta:jira, read:issue-security-level:jira, read:issue.vote:jira, read:issue.changelog:jira, read:avatar:jira, read:issue:jira, read:status:jira, read:user:jira, read:field-configuration:jira
    Look up Latest Comment on Issue Retrieves the latest comment for the specified issue from Jira. You can use this action in a flow or subflow for validation. For example, a subflow adds an additional comment only when the latest comment of an issue in Jira isn’t as the same specified comment. read:jira-work read:comment:jira, read:comment.property:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:avatar:jira
    Look up Server Retrieves general information about the current Jira instance. Any scope Any scope
    Webhook Management Look up Webhooks Retrieves details of all registered webhooks from the Jira instance. Scoped API token is not supported for this action.
    Subscribe Webhook Registers a webhook in the Jira instance. Scoped API token is not supported for this action.
    Unsubscribe Webhook Deletes the registered webhook in Jira instance. Scoped API token is not supported for this action.
    Update Webhook Updates webhook with the given ID in Jira.
    Note:
    This action isn’t supported when OAuth 2.0 authentication is used.
    		 Scoped API token is not supported for this action.