Jira Cloud configuration

This page describes how to set up and configure a third-party configuration before creating the Jira Cloud data store.

Set up authentication and permissions

You need to set up authentication and permissions in the Atlassian administrator account center. This is crucial for allowing the connector to access and synchronize data. The Jira Cloud connector supports various authentication methods, such as OAuth client credentials or API tokens.

Create an OAuth 2.0 app

To create an OAuth 2.0 app for authentication, follow these steps to set up the application in your Atlassian Developer Console and obtain the necessary client ID and client secret.

Verify Jira organization administrator access

To verify Jira organization administrator access, do the following:

1. Sign-in to Atlassian with your user credentials.

2. Select the Jira app.

3. Click Settings.

   If you see the System option under Jira settings, you have Jira organization administrator access. Otherwise, request your Jira organization administrator to provide access.

Create OAuth 2.0 app

To create an OAuth 2.0 app, do the following:

1. Sign in to the Atlassian Developer Console.

2. Click the profile icon and select Developer console.

3. In the Console page, click Create and select OAuth 2.0 Integration.

4. In the app creation page, do the following:

   1. Enter a name for the app.

   2. Select the checkbox to agree to Atlassian's developer terms.

   3. Click Create.

5. In the app page, do the following:

   1. From the navigation menu, click Authorization.

   2. In the Authorization type table, select Add for OAuth 2.0 (3LO).

6. In the Callback URL field, enter https://vertexaisearch.cloud.google.com/console/oauth/jira_oauth.html.

7. Click Save changes.

Obtain client ID and client secret

To obtain the client ID and client secret, do the following:

1. In the app page, from the navigation menu click Distribution.

2. In the Distribution page, do the following:

   1. In the Distribution controls section, select Edit.
   2. In the Distribution status section, select Sharing to enable editing other fields.
   3. Enter information in the following mandatory fields:
      1. For Vendor, enter Google.
      2. For Privacy policy, enter https://policies.google.com.
      3. For Does your app store personal data?, select Yes.
      4. Select I confirm that I've implemented the personal data reporting API checkbox. For more information, see Personal data reporting API.
   4. Click Save changes.

3. In the app page, do the following:

   1. From the navigation menu, click Settings.
   2. From the settings page, copy your Client ID and Client secret.

Obtain an instance ID and instance URL

1. Obtain the instance ID:

   1. Open a new tab, copy the instance URL, and append /_edge/tenant_info to the instance URL. For example, https://YOUR_INSTANCE.atlassian.net/_edge/tenant_info.
   2. Navigate to the link to find the cloudId value. The cloudId is your instance ID.

2. Obtain the instance URL:

   1. Go to atlassian.net and sign in with your administrator account.
   2. Select the app you want to sync. For example, sync the first app.
   3. Find the instance URL (the subdomain in the address bar).

Grant administrator roles

To grant the Jira administrator the Discovery Engine Editor role in the Google Cloud console, do the following:

1. In the Google Cloud console, go to the Gemini Enterprise page.

2. Navigate to IAM.

   Go to IAM

3. Locate the user account which has administrator access in Jira and click the Edit icon .

4. Grant the Discovery Engine Editor role to the administrator.

To grant a user an administrator role in Atlassian, do the following:

1. Sign in to Atlassian using an organization administrator account.

2. Click the menu icon and select your organization. Alternatively, you can go to admin.atlassian.com.

3. On the Admin page, click the product and select the Manage users button.

   

   Manage users

4. Click Groups under User management.

5. On the Groups page:

   1. Click Create group.
   2. Enter a name for the group.

   

   Create group

This group receives permissions required by the connector. Users added to this group inherit these permissions. The connector uses this group to authenticate and fetch documents.

1. On the Group page, click Add product.

2. Select User access admin as the role for Jira.

3. Select Product admin as the role for Jira administration.

   

   Jira user access administrator

4. Click Grant Access.

5. Click Add group members to add a user account or group members that the connector uses to authenticate and access the required resources.

   

   Add group members

Manage user visibility

To make the user's email visible to anyone in the Atlassian account, do the following:

1. Sign in to the Atlassian Developer Console.

2. Click the profile icon and select Developer console.

3. Click the user profile icon and select Manage account.

   

   Manage account

4. Navigate to the Profile and visibility.

   

   Profile and visibility

5. Go to Contact and set the Who can see this as Anyone.

   

   Contact

To make the user's email visible to anyone in Jira, do the following:

1. Sign in to Atlassian with your user credentials.

2. Select a Jira app.

3. Click Settings > System.

4. Select General Configuration in the left pane.

5. Click Edit Settings.

6. For User email visibility, select Public.

   

   Select email visibility

7. Click Update.

Configure minimum application scopes

To perform the defined actions, you need to set up the following permissions for the Jira Cloud connector in the Atlassian platform.

1. On the application page, click Permissions.

2. Go to Jira API and click Add.

   Note: After adding the Jira API, the Configure button might take a moment to appear. If it doesn't show up immediately, try refreshing the page or waiting a few seconds.

3. Click Configure.

4. Go to the Classic scopes tab.

5. Click Edit scopes and select the classic scopes as per your requirement from the following table:

Connection mode	Permission	Purpose
Federated search and actions	read:jira-user, read:jira-work	Required to fetch and display search results and user details in real-time.
	write:jira-work	Allows the assistant to modify work items (e.g., updating issue fields) and manage comments or issues.
Federated search only	read:jira-user, read:jira-work	Required to search for and view issues, projects, and user profiles.
Data ingestion and actions	read:jira-work	Required for broad data crawling and indexing of work items.
	write:jira-work	Necessary to perform write actions (creation, updates, comments) on work items within the ingested environment.
Data ingestion	read:jira-work	Required to crawl and index Jira content for search availability.

1. Confirm all the scopes are selected, and click Save.

2. Go to the Granular scopes tab.

3. Click Edit scopes and select the granular scopes as per your requirement from the following table:

Connection mode	Permission	Purpose
Federated search and actions	write:comment:jira	Enables the assistant to post new comments or replies directly from the search interface.
	write:issue:jira	Necessary to create new issues or perform major edits to existing ones.
Data ingestion and actions	read:user:jira, read:group:jira, read:avatar:jira	Required for syncing user/group metadata and displaying user profiles.
	read:issue-security-level:jira, read:issue-security-scheme:jira	Critical for access control; ensures the ingested data respects Jira's security boundaries.
	read:audit-log:jira	Used to track changes and perform incremental syncs to keep ingested data up to date.
	write:comment:jira	Required to add comments to issues using the assistant.
	write:issue:jira	Enables creating or modifying issues.
Data ingestion	read:user:jira, read:group:jira, read:avatar:jira	Required to crawl and index Jira content and user relationships.
	read:issue-security-level:jira, read:issue-security-scheme:jira	Required to map permissions so only authorized users can search the ingested data.
	read:audit-log:jira	Necessary for the sync engine to identify which items have been updated or deleted.

1. Confirm all the scopes are selected, and click Save.

Note: If you want to skip actions and use the data store for search, you can limit the permissions to just read permissions. write permissions are required only to perform the actions mentioned in Supported actions.

Install User Identity Accessor

To install the User Identity Accessor for Jira Cloud app on your Jira Cloud site, follow these steps:

1. Navigate to Atlassian Developer Console.

2. Review the Read Email Address and App Storage scope permissions and click Get app.

   

   Review permissions and get app

3. From the Select a site to install this app on list, select the Jira site where you want to install the app. This list displays only the sites for which you have administrator access.

   Note: You must be an administrator of at least one Jira site to install the app.

4. Click Install to complete the app installation.

Configure User Identity Accessor

After you've installed the User Identity Accessor for Jira Cloud app, configure an API key that your external system (for example, your Jira Cloud Connector) uses to securely call the app's web trigger to fetch emails.

Access the configuration page

To access the User Identity Accessor for Jira Cloud app's configuration page, do the following:

1. In your Jira Cloud instance, click the Settings ⚙️ icon in the navigation menu.
2. Select Apps from the menu.
3. On the Apps administration page, locate your app, User Identity Accessor for Jira Cloud, in the Manage apps list.

4. Click Configure or the link associated with your app. The app's dedicated configuration page opens within Jira Cloud.

   

   Configure the User Identity Accessor for Jira Cloud app

Set up the API key

To set up the API key on the configuration page, do the following:

1. In the API Key Configuration section, specify the secret key for authenticating requests to the app's web trigger. You can authenticate requests using either of the following methods:

   • Enter your own key: Type or paste your own strong, unique API key into the API Key field. Use a key of at least 20–30 characters with a mix of uppercase letters, lowercase letters, numbers, and symbols.

     

     Enter your own key

   • Generate a key: Click the Generate New Key button. The system generates and displays a strong, random key in the field.

     

     Generate a key

     Important: Immediately copy the API key displayed in the field. For security reasons, you might be unable to view the full key again after saving or navigating away. If lost, you need to set or generate a new one.

2. Click Save API Key. A success message confirms that the key is securely saved.

Note: The API key generated or created in this section serves as the value for the Jira Identity Sync Forge Client Secret field in the Advanced Options section during Connector setup.

Test the app configuration

Verify if the User Identity Accessor for Jira Cloud app is configured correctly by sending a request from your external system and confirming that user email addresses are returned successfully.

Get the web trigger URL

1. On the Apps administration page, locate the Webtrigger URL section, which displays the unique URL specific to your Jira site and this app installation:
   • Your external system must call this URL to request user emails.
   • URL example: https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/WEBTRIGGER_ID, where YOUR_INSTANCE_ID is your Jira Cloud instance identifier and WEBTRIGGER_ID is the unique identifier for the web trigger endpoint generated for your app.
2. Click the Copy URL button or copy the entire URL.

Configure your external system

• Configure your external system that needs to fetch Jira user emails with the API key and web trigger URL obtained in the previous steps.

• Endpoint URL: The web trigger URL you copied.

• HTTP Method: POST

• Required Headers:

  • Content-Type: application/json

  • X-Api-Key: YOUR_API_KEY

    Replace YOUR_API_KEY with the API key you set or generated in the Set up the API key section.

Example curl command

This example demonstrates calling the User Identity Accessor for Jira Cloud web trigger, which accepts an array of account IDs and returns the email addresses.

curl --location --request POST 'https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/ENDPOINT_PATH' \
--header 'X-Api-Key: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
   "accountIds": [
       "ACCOUNT_ID_1",
       "ACCOUNT_ID_2"
   ]
}'

Replace:

• YOUR_INSTANCE_ID with your Jira Cloud instance ID
• ENDPOINT_PATH with the API endpoint path
• YOUR_API_KEY with the API key you set or generated in the Set up the API key section
• ACCOUNT_ID with Atlassian account IDs that you want to target

Expected response

[{"accountId":"ACCOUNT_ID_1","emailAddress":"EMAIL_ADDRESS_1"},
 {"accountId":"ACCOUNT_ID_2","emailAddress":"EMAIL_ADDRESS_2"}]

Replace:

• ACCOUNT_ID_X with actual Atlassian account IDs
• USER_EMAIL_X with user email addresses returned from your API call

Implement security best practices

To confirm the security of your API key, follow these recommendations:

• Store the API key securely within your Jira Cloud Connector's configuration.
• Verify that all communication with the webhook URL occurs over HTTPS. This is the default for User Identity Accessor for Jira Cloud web triggers.

Support for User Identity Accessor for Jira Cloud

Support offerings are available from Google for the User Identity Accessor for Jira Cloud app that can include maintenance and regular updates to keep the app up-to-date. If you encounter any issues or have questions specific to the app functionality, contact Google Cloud Support. For more information, see Getting Cloud Customer Care.