Share via


Deploy the Confluence Cloud Copilot connector in the Microsoft 365 admin center

The Confluence Cloud Microsoft 365 Copilot connector integrates Confluence content into Microsoft 365, enabling Copilot, Copilot Search, and Microsoft Search to surface relevant wiki pages and blogs directly within apps like Teams, Outlook, and SharePoint.

This article describes the steps to deploy, customize, and troubleshoot the Confluence Cloud Copilot connector. For general information about Copilot connector deployment, see Set up Copilot connectors in the Microsoft 365 admin center.

For advanced Confluence Cloud configuration information, see Set up the Confluence Cloud service for connector ingestion.

Prerequisites

Before you deploy the Confluence Cloud connector, make sure that the Confluence environment is configured in your organization. The following table summarizes the steps to configure the Confluence environment and deploy the connector.

Role Task
Confluence admin Configure the environment
Confluence admin/Network admin Set up prerequisites
Microsoft 365 admin Deploy the connector in the Microsoft 365 admin center
Microsoft 365 admin Customize connector settings (optional)

To deploy the connector, you must meet the following prerequisites:

  • You must be an admin for your organization's Microsoft 365 tenant and your organization's Confluence site.
  • You must have authentication credentials with the right access.

Deploy the connector

To add the Confluence Cloud connector for your organization:

  1. In the Microsoft 365 admin center, in the left pane, choose Copilot > Connectors.
  2. Go to the Connectors tab, and in the left pane, choose Gallery.
  3. From the list of available connectors, choose Confluence 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 Confluence 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 Confluence site, use your site URL, which is typically the following:  https://<organization_name>.atlassian.net.

The <organization_name> value is the unique identifier for your Confluence Cloud site.

Choose authentication type

To authenticate and synchronize content from Confluence, choose one of the following authentication types:

  • Basic authentication - To authenticate using basic auth, enter your username (usually your email address) and API token. To generate an API token, see Manage API tokens for your Atlassian account.

  • OAuth 2.0 (recommended) - Register an app in Confluence Cloud so that Microsoft Search and Microsoft 365 Copilot can access the instance. For more information, see Enabling OAuth 2.0 (3LO).

    To register the app:

    1. Sign in to the Atlassian Developer console with your Atlassian Confluence admin account.
    2. Choose Create and select OAuth 2.0 integration.
    3. Provide a name for the application and create the new app.
    4. On the left pane, choose Permissions, and next to Confluence API, choose Add.
    5. Choose Configure > Edit scopes, and select the scopes listed in the following table.
    Scope name Code Description
    View content details read:content-details:confluence Crawl content that satisfies the criteria.
    View groups read:group:confluence Access group permissions of content.
    View user details read:user:confluence Access individual user details to support permissions.
    View audit records read:audit-log:confluence Access audit records for Confluence events to support permissions.
    View pages read:page:confluence Access page content details to support permissions.
    View spaces read:space:confluence Access space details to support permissions.
    View content summaries read:content.metadata:confluence Access information about the content to support permissions.
    View comments read:comment:confluence View comments on pages or blogposts.
    View and download content attachments read:attachment:confluence View and download attachments of a page or blogpost that you have access to.
    1. Choose Save.
    2. In the left pane, go to Authorization. Add the callback URL for Microsoft 365, as follows:
      • Microsoft 365 Enterprise - https://gcs.office.com/v1.0/admin/oauth/callback
      • Microsoft 365 Government - https://gcsgcc.office.com/v1.0/admin/oauth/callback
    3. Choose Save.
    4. In the left pane, go to Settings. Copy the Client ID and Secret. Complete the connection settings step by using the Client ID and Secret.

Tip

Make sure that the service account has view access to the Confluence content you want to index.

Roll out

Deploy the connection to a limited set of users to validate it in Copilot and other search surfaces before you roll it out to a broader audience. For more information, see Staged rollout for Microsoft 365 Copilot connectors.

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.

To deploy the connector, choose Create in the Microsoft 365 admin center. The Confluence Cloud Copilot connector starts indexing pages from your Confluence account right away.

The following table lists the default values that are set. These values work best with Confluence data.

Category Setting Default value
Users Access permissions Only people with access to the content in the data source.
Users Map identities Data source identities mapped using Microsoft Entra IDs.
Content Include/exclude space All
Content Manage properties For default properties and schemas, see Manage properties.
Sync Incremental crawl Frequency: Every 15 minutes
Sync Full crawl Frequency: Every day

To customize these values, see Customize settings.

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 Confluence Cloud connector settings. To customize settings, on the connector page in the admin center, choose Custom setup.

Customize user settings

The Confluence Cloud connector supports the following user search permissions:

  • Everyone
  • Only people with access to this data source (default)

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 it. In Confluence Cloud, security permissions for users and groups are defined using space permissions and page restrictions. Page-level restrictions, if present, take precedence over space permissions.

If no page restrictions are specified, the connector checks for space-level permissions, and applies the following:

  • If the space has anonymous users access enabled, the content is visible to all users in your tenant.
  • If the space doesn't have anonymous access enabled, the space-level permissions are honored.
  • If space-level permissions aren't defined, the content is not visible to any user in your tenant.

Important

Permissions are managed at the space and page level only. Parent page permissions aren't applied.

If you choose Only people with access to this data source, you also need to choose whether your Confluence site has Microsoft Entra ID provisioned users or non-Entra ID users:

  • Choose the Microsoft Entra ID option if the email ID of Confluence users is same as the user principal name (UPN) in Microsoft Entra ID.
  • Choose the non-Entra ID option if the email ID of Confluence users is different from the UPN in Microsoft Entra ID.

Note

  • If you choose Microsoft Entra ID as the identity source, the connector maps user email IDs from Confluence to the UPN property in Microsoft Entra ID.
  • If you choose non-Entra ID as the identity source, provide a regular expression to map email ID to UPN. For more information, see Map your non-Entra ID identities.
  • Updates to users or groups that govern access permissions are synced in full crawls only. Incremental crawls don't currently support processing updates to permissions.

Customize content settings

You can customize what data is included and excluded and customize the default connector properties.

Include or exclude data

By default, the Confluence Cloud connector indexes all blogs and pages. You can include or exclude data that you want to index. You can use a Confluence Query Language (CQL) string to specify conditions for syncing pages. For example, you can choose to index only the pages that were modified in the last two years. For more information, see Advanced Searching using CQL.

Tip

You can use the CQL filter to index content modified after a certain time by using, for example, lastModified >= "2024/12/31".

Choose Preview results to verify the sample values of the selected properties and CQL string.

Manage properties

To add or remove available properties from your Confluence Cloud connector, 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 properties are indexed by default.

Default property Label Description
Authors authors Name of people who participated/collaborated on the item in the data source.
CreatedByName createdBy Name of the person who most recently edited the item in the data source.
IconUrl iconUrl The associated icon URL of the item.
Title title The title of the item that you want to be shown in search and other experiences.
UpdatedByName lastModifiedBy Name of the person who most recently edited the item in the data source.
UpdatedOn lastModifiedDateTime Date and time the item was last modified in the data source.
Url url The target URL of the item in the data source.

Choose the Preview results button to verify the selected properties and filters.

Customize sync intervals

The refresh interval determines how often your data is synchronized between the data source and the Confluence Cloud connector index. Copilot connectors use two types of refresh intervals:

  • Full crawl
  • Incremental crawl

You can change the default values of the refresh intervals. For more information, see Guidelines for sync settings.