Configure Atlassian Jira Cloud for external content indexing

  • Versão de lançamento: Australia
  • Atualizado 12 de mar. de 2026
  • 3 min. de leitura

    • Register an OAuth 2.0 integration in the Atlassian Developer console and create an API key in Atlassian Administration to allow the Atlassian Jira Cloud external content connector to crawl projects and security principals in your Atlassian Jira Cloud source system.

    Antes de Iniciar

    You need the following credentials and permissions for your organization's Atlassian management applications:
    Atlassian portal Required credentials and permissions
    Atlassian Developer console (https://developer.atlassian.com/console/myapps/)
    • Login credentials
    • Permission to view settings for registered applications
    • Permission to register a new application
    • Permission to set granular Jira API scopes for an application
    • Permission to set the OAuth 2.0 callback URL for an application
    Atlassian Administration (https://admin.atlassian.com/)
    • Login credentials
    • Permission to create a new admin API key

    Role required: none

    Por Que e Quando Desempenhar Esta Tarefa

    The Atlassian Jira Cloud external content connector retrieves content from your Atlassian Jira Cloud source system using the Jira API.

    To allow the connector to access your Atlassian Jira Cloud source system via the Jira API, you must configure an OAuth 2.0 integration in the Atlassian Developer console and an API key in Atlassian Administration. Your ServiceNow AI Platformconnector admin can use settings copied from the OAuth 2.0 integration and the API key to configure the Atlassian Jira Cloud external content connector for proper connection to your Atlassian Jira Cloud source system.

    Procedimento

    1. Find the instance ID for your Atlassian Jira Cloud tenant.
      1. Navigate to https://<tenant-name>.atlassian.net/_edge/tenant_info, replacing <tenant-name> with the name of your Atlassian Jira Cloud tenant.

        The web endpoint displays a JSON response showing the cloud ID (instance ID) for your tenant.

        Cloud ID for Atlassian Jira Cloud shown in JSON format.

      2. Record the value of the cloudId JSON parameter in a secure location.
        Importante:
        Your ServiceNow AI Platformconnector admin needs this instance ID value when configuring the Atlassian Jira Cloud external content connector.
    2. In the Atlassian Developer console, register a new OAuth 2.0 integration for the Atlassian Jira Cloud external content connector.
      1. Login to the Atlassian Developer console at https://developer.atlassian.com/console/myapps/.
      2. In the My apps section, select Create > OAuth 2.0 integration.
        Create button and OAuth 2.0 integration menu item on Atlassian Developer console My apps page.
      3. Enter a name for your OAuth 2.0 integration, select the option to agree to Atlassian's developer terms, and select Create.
        OAuth 2.0 (3LO) integration name, Atlassian developer terms option, and Create button on Atlassian Developer console.

        As an example, you might enter Jira Cloud external content connector as the name for your OAuth 2.0 integration.

      4. Navigate to the OAuth 2.0 integration's Permissions page, then select Add in the Jira API row.
        Add Jira API button on Atlassian Developer console Permissions page.
      5. In the Jira API row, select Configure.
        Configure Jira API button on Atlassian Permissions console.
      6. On the Granular scopes tab, select Edit Scopes and then select the options for each of the following scopes:
        • read:application-role:jira
        • read:attachment:jira
        • read:audit-log:jira
        • read:avatar:jira
        • read:comment.property:jira
        • read:comment:jira
        • read:field-configuration:jira
        • read:field:jira
        • read:group:jira
        • read:issue-details:jira
        • read:issue-meta:jira
        • read:issue-security-level:jira
        • read:issue-security-scheme:jira
        • read:issue-type-hierarchy:jira
        • read:issue-type:jira
        • read:issue.changelog:jira
        • read:issue.vote:jira
        • read:issue:jira
        • read:permission-scheme:jira
        • read:permission:jira
        • read:project-category:jira
        • read:project-role:jira
        • read:project-type:jira
        • read:project-version:jira
        • read:project.component:jira
        • read:project.feature:jira
        • read:project.property:jira
        • read:project:jira
        • read:status:jira
        • read:user.property:jira
        • read:user:jira
        Edit Scopes button on Atlassian Developer console Permissions page.
      7. Select Save.
        Save button in Atlassian Developer console Edit Jira API dialog box.
      8. Navigate to the OAuth 2.0 integration's Authorization page, then select Add in the row for the OAuth 2.0 (3LO) authorization type.
        Add OAuth 2.0 (3LO) authorization button on Atlassian Developer console Authorization page.
      9. Enter https://<instance-name>.service-now.com/oauth_redirect.do as the callback URL, replacing <instance-name> with your ServiceNow AI Platform® instance name, then select Save changes.
        Callback URL field and Save changes button on Atlassian Developer console Authorization page.
      10. Navigate to the OAuth 2.0 integration's Settings page and record the Client ID and Secret values in a secure location.
        Client ID and Secret fields on Atlassian Developer console Settings page.
        Importante:
        Your ServiceNow AI Platformconnector admin needs these Client ID and Secret values when configuring the Atlassian Jira Cloud external content connector.
    3. In Atlassian Administration, create a new admin API key.
      1. Login to Atlassian Administration at https://admin.atlassian.com/.
      2. Select Settings in the tab list.
        Atlassian Administration console Settings tab.
      3. Select API keys, then select Create API key.
        Create API key button on API keys page of Atlassian Administration console Settings section.
      4. On the Before you begin page, select API key without scopes, then select Next.
        API key scopes options in Atlassian Administration console dialog box.
      5. Enter a name and an expiration date for your new API key.
        API key name field, expiration-date field, and Create button in Atlassian Administration console dialog box.

        As an example, you might enter Jira Cloud external content connector as the name for your API key and set its expiration date to be one year in the future.

      6. Select Create.
      7. Record the value of the API key in a secure location.
        API key in Atlassian Administration console dialog box.
        Importante:
        Your ServiceNow AI Platformconnector admin needs the API key's value when configuring the Atlassian Jira Cloud external content connector.
      8. Select Done.
    4. Configure a technical user in your Atlassian Jira Cloud tenant to allow access by the Atlassian Jira Cloud external content connector.
      For details on this procedure, see Configure a connector user in Atlassian Jira Cloud.

    O que Fazer Depois

    Provide the following items to your ServiceNow AI Platformconnector admin:
    • The instance ID (cloud ID) value that you recorded in step 1.b.
    • The OAuth 2.0 integration's Client ID and Secret values that you recorded in step 2.j.
    • The API key's value that you recorded in step 3.g.
    • The credentials for the Atlassian Jira Cloud user that you created in step 4.

    Your ServiceNow AI Platformconnector admin needs these items to configure an Atlassian Jira Cloud external content connector to retrieve projects and security principals from your Atlassian Jira Cloud instance.

    For details on creating and configuring an Atlassian Jira Cloud external content connector, see Create an Atlassian Jira Cloud external content connector.