Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The Atlassian Jira Cloud Microsoft 365 Copilot connector allows your organization to index Jira issues. After you configure the connector and index content from the Jira site, users can search for those items in Microsoft Search and Microsoft 365 Copilot experiences.
This article describes the steps to deploy and customize the Atlassian Jira Cloud connector.
Important
The Atlassian Jira Cloud Copilot connector supports only Jira cloud-hosted instances. This connector doesn't support Jira Server and Jira Data Center versions.
For Jira Cloud service configuration information, see Set up the Jira Cloud service for connector ingestion.
Prerequisites
Before you deploy the Atlassian Jira Cloud connector, make sure that the Jira Cloud environment is configured in your organization. The following table summarizes the steps to configure the Jira Cloud environment and deploy the connector.
| Task | Role |
|---|---|
| Set up the Jira Cloud service | Jira Cloud admin |
| Deploy the connector in the Microsoft 365 admin center | Microsoft 365 admin |
| Customize connector settings (optional) | Microsoft 365 admin |
Before you deploy the connector, make sure that you meet the following prerequisites:
- You must be the search admin for your organization's Microsoft 365 tenant.
- Make sure that you know the Jira Cloud instance URL for your organization. To connect to your Jira data, you need your organization's Jira instance URL.
- To connect to Jira and allow the Atlassian Jira Cloud Copilot connector to update issues regularly, you need a service account with the following permissions granted to it.
| Permission name | Permission type | Required for |
|---|---|---|
| Browse projects | Project permission | Crawling Jira issues. This permission is required for the projects that need to be indexed. |
| Issue level security permissions | Issue-level security | Crawling different issue types. This permission is optional. |
| Browse users and groups | Global permission | Security trimming based on access permissions of search results. This permission is required if you select the Only people with access to this data source user setting; otherwise, it's optional. |
| Administer Jira | Global permission | Security trimming based on access permissions of search results. This permission is required if you select the Only people with access to this data source user setting; otherwise, it's optional. |
Deploy the connector
To add the Atlassian Jira Cloud connector for your organization:
- In the Microsoft 365 admin center, in the left pane, choose Copilot > Connectors.
- Go to the Connectors tab, and in the left pane, choose Gallery.
- From the list of available connectors, choose Atlassian Jira Cloud.
Set display name
The display name is used to identify references in Copilot responses to help users recognize the associated file or item. The display name also signifies trusted content and is used as a content source filter.
You can accept the default Atlassian Jira Cloud display name, or customize the value to use a display name that users in your organization recognize.
For more information about connector display names and descriptions, see Enhance Copilot discovery with Microsoft 365 Copilot connectors content.
Set instance URL
To connect to your Jira cloud data, you need your organization's Jira instance URL. Your organization's Jira instance URL typically looks like the following: https://<your-organization-domain>.atlassian.net.
If you don't have an instance already, see Atlassian Jira to create a test instance.
Choose authentication type
To authenticate and sync issues from Jira, choose one of the following supported authentication methods:
Basic authentication - Enter your account's username (usually email ID) and API token to authenticate using basic auth. For information about how to generate an API token, see Manage API tokens for your Atlassian account.
Atlassian Jira OAuth 2.0 (recommended) - To use the Jira OAuth for authentication:
- Register an app in Atlassian Jira so the Microsoft Search app and Microsoft 365 Copilot can access the instance. For more information, see Enable OAuth 2.0.
- Sign in to Atlassian Developer console with your Atlassian Jira admin account.
- Choose Create and select OAuth 2.0 integration.
- Provide an appropriate name for the application and create the new app.
- Go to Permissions from the navigation pane on the left. Select Add for Jira API and select Configure. Under Granular Permissions, add the required scopes.
- Go to Authorization from the navigation pane on the left to add the callback URL:
- For Microsoft 365 Enterprise:
https://gcs.office.com/v1.0/admin/oauth/callback - For Microsoft 365 Government:
https://gcsgcc.office.com/v1.0/admin/oauth/callback
- For Microsoft 365 Enterprise:
- Choose Save.
- Go to Settings in the left pane to get the client ID and secret. Complete the connection settings step using the Client ID and Secret.
Note
- For more information about Jira permissions, see Jira scopes for OAuth 2.0.
- The original (classic) OAuth permissions for Jira Cloud are deprecated. For more information, see the changelog announcement.
Roll out
To roll out to a limited audience, choose the toggle next to Rollout to limited audience and specify the users and groups to roll the connector out to. For more information, see Staged rollout for Microsoft 365 Copilot connectors.
Choose Create to deploy the connection. The Atlassian Jira Cloud Copilot connector starts indexing content right away.
The following are the default values for the connector:
Users
- Access permissions: Only people with access to content in Data source.
- Map Identities: Data source identities mapped using Microsoft Entra IDs.
Content
- Site projects: All projects are indexed.
- Filter data: All issues are indexed. No time filter or JQL criteria is applied.
- Manage Properties: To check default properties and their schema, see Customize content settings
Sync
- Incremental Crawl: Frequency: Every 15 mins
- Full Crawl: Frequency: Every Day
After you create your connection, you can review the status in the Connectors section of the Microsoft 365 admin center.
Customize settings (optional)
You can customize the default values for the Atlassian Jira Cloud connector settings. To customize settings, on the connector page in the admin center, choose Custom setup.
Customize user settings
Access permissions
The Atlassian Jira Cloud Copilot connector supports search permissions visible to Everyone or Only people with access to this data source. If you choose Everyone, indexed data appears in the search results for all users. If you choose Only people with access to this data source, indexed data appears in the search results for users who have access to them. In Atlassian Jira, security permissions are defined using project permission schemes containing site-level groups and project roles. Issue-level security can also be defined using issue-level permission schemes.
Important
The Atlassian Jira Cloud Copilot connector must be able to read a user's email ID in Jira to appropriately assign security permissions in Microsoft Search and Microsoft 365 Copilot. This requires you to ensure either of the following:
- All users should select the Anyone option for their profile visibility settings. To learn more about profile visibility settings, see Update your profile and visibility settings.
- For organizations that use managed accounts:
- All users must have the managed account setting selected in profile visibility settings.
- Users who aren't part of the managed account (same as crawling account) must have Anyone selected in their profile visibility settings.
- The crawling account used during connection configuration must have the managed account domain.
Mapping identities
The default method for mapping your data source identities with Microsoft Entra ID is to make the email ID of Jira users the same as the user principal name (UPN) or email address of the users in Microsoft Entra ID. If the default mapping doesn't work for your organization, you can provide a custom mapping formula. For more information, see Map your non-Azure AD Identities.
- Choose the Microsoft Entra ID option if the email ID of Jira users is the same as the UPN of users in Microsoft Entra ID.
- Choose the Non-Microsoft Entra ID option if the email ID of Jira users is different from the UPN and email of users in Entra ID.
Note
Updates to groups that govern access permissions are synced in full crawls only. Incremental crawls don't support the processing of updates to permissions.
Customize content settings
Choose projects and filter data
- Site projects: You can choose for the connection to index either the entire Jira site or specific projects only.
- If you choose to index the entire Jira site, Jira issues in all projects on the site are indexed. New projects and issues are indexed during the next crawl after they're created.
- If you choose individual projects, only Jira issues in the selected projects are indexed.
Note
When you grant the Browse projects permission to a Jira project, it's listed in the project selection and can be crawled. If a project is missing, check the permissions for your account.
- Filter data: You can choose to filter the Jira issues that are indexed in two ways:
- Specify the issue modified time period. This option only indexes the Jira issues that are created or modified in the time period selected on a rolling basis based on the current crawl.
- Use the JQL filter to index only specific Jira issue types by using
issueType in (Bug, Improvement).
Manage properties
You can add or remove available properties from your Jira data source, assign a schema to the property (define whether a property is searchable, queryable, retrievable, or refinable), change the semantic label, and add an alias to the property. The following table lists the properties that are selected by default.
| Source property | Label | Description | Schema |
|---|---|---|---|
| Authors | Authors | Name all the people who participated/collaborated on the item | Retrieve |
| Created | Created date time | Date and time that the item was created in the data source | Query, Retrieve |
| IssueDescription | Content | The description of the issue | Search |
| IssueIconURL | IconUrl | Icon url that represents the issue type | Retrieve |
| IssueId | |||
| IssueKey | |||
| IssueLink | url | The target URL of the item in the data source | Query, Retrieve |
| IssueStatus | Query | ||
| IssueSummary | |||
| ProjectName | Query | ||
| ReporterEmailId | Created by | Retrieve | |
| ReporterName | Query, Retrieve | ||
| Title | Title | The title of the item that you want shown in Copilot and other search experiences | Search, Query, Retrieve |
| Updated | Last modified date time | Date and time the item was last modified in the data source | Query, Retrieve |
Note
- The Atlassian Jira Cloud Copilot connector can index both default issue fields and custom-created issue fields.
- If a selected custom-created field isn't present in some Jira issue type, the field is ingested as NULL (blank).
- The list of properties that you select affects how users can filter, search, and view results in Copilot.
Preview data
Use the preview results button to verify the sample values of the selected properties and query filter.
Customize sync intervals
The refresh interval determines how often your data is synced between the data source and the Atlassian Jira Cloud Copilot connector index. The following are the two types of refresh intervals:
- Incremental crawl: Every 15 mins
- Full crawl: Every day
You can change the default values of the refresh interval. For more information, see Guidelines for sync settings.