Skip to main content
Back to Search AI connectors list The Confluence Cloud Connector integrates Search AI with your Atlassian Confluence Cloud account, enabling intelligent search over your organization’s knowledge articles using OAuth 2.0 authentication.
SpecificationDetails
Repository typeCloud
Supported API versionREST API v1
Supported contentKnowledge Articles
Access control supportYes
Only manually created Knowledge Articles are supported. Searching through other uploaded content types such as PDF files, attachments, docs, and images is not supported.

Prerequisites

Step 1: Configure an OAuth Application on Confluence Cloud

Sign in to your developer account at the Atlassian Developer Portal. Click your profile name at the top right and navigate to the Developer Console. Confluence Home The Developer Console lists all your apps. Apps Click Create and select OAuth 2.0 Integration. Create App Provide a name for the application and click Create. Create App Update the application name and description from the Settings tab, optionally add an avatar, and click Save changes. App Settings

Configure the Callback URL

Go to the Authorization tab and enter the Search AI callback URL for your region, then click Save changes.
RegionCallback URL
JPhttps://jp-bots-idp.kore.ai/workflows/callback
DEhttps://de-bots-idp.kore.ai/workflows/callback
Prodhttps://idp.kore.com/workflows/callback
App Settings

Grant API Permissions

Go to the Permissions tab and add the following APIs:
  • User Identity API
  • Confluence API
  • Jira API
App Permissions User Identity API — Click config, then Edit Scopes, grant the following permissions, and click Save:
  • read:me
  • read:account
API Scope Confluence API — Go to Granular Scopes, select Edit Scopes, add the following permissions, and click Save:
  • read:analytics.content:confluence
  • read:content-details:confluence
  • read:content.permission:confluence
  • read:content:confluence
  • read:page:confluence
  • read:space-details:confluence
  • read:space.permission:confluence
  • read:space:confluence
  • read:user.property:confluence
For Classic Scopes, add read:confluence-groups and click Save. API Scope Jira API — Go to Classic Scopes, select Edit Scopes, add read:jira-user, and click Save. API Scope

Retrieve Client ID and Client Secret

Go to Settings and locate the Client ID and Secret at the bottom of the page. Save these for use in the next step. Settings

Retrieve the Host URL

Go to the Confluence home page, click your Profile, and navigate to the Products tab. The host URL is displayed at the bottom of the page. Profile Products Host URL

Step 2: Configure the Search AI Connector

Go to Content > Connectors and select the Confluence Cloud connector. On the Authorization tab, enter the following fields:
FieldDescription
NameUnique name for the connector
Authorization TypeOAuth 2.0
Grant TypeAuthorization Code
Client IDClient ID from the Confluence OAuth application
Client SecretClient Secret from the Confluence OAuth application
Host URLConfluence server base URL (without trailing slash)
Click Connect. On successful authorization, the connector is marked as Connected. Authorization does not initiate content synchronization.

Content Ingestion

Go to the Configuration tab and select the content to ingest. You can sync all content from the Confluence Cloud account or select specific content. Content Ingestion

Content Filters

To selectively ingest content, select Sync Specific Content and click Configure. Define rules using a parameter, operator, and value. Content Filters Supported filter parameters:
ParameterDescription
AncestorDirect child pages and descendants of given content IDs
ContentSpecific content by content ID
CreatedContent by creation date (yyyy/mm/dd hh:mm, yyyy-mm-dd hh:mm, yyyy/mm/dd, yyyy-MM-dd)
CreatorContent created by specified user account IDs
LabelContent filtered by label
ParentContent under a given parent
IDContent by content ID
SpaceContent in a specific space
TitleContent by page title
UserContent by user ID
You can also add custom CQL fields. Refer to the complete list of supported CQL fields. The Operator field accepts values such as equals, not equal, and contains, depending on the selected parameter. Example: Ingest all pages and sub-pages under a given ancestor: Example Example: Ingest only pages created or modified after January 1, 2024: Example
  • Use the OR operator to combine multiple rules for different content types.
  • Use the AND operator within a rule to apply multiple conditions. For example, to ingest content created after January 1, 2024 with “SearchAI” in the title:
Example

Content Sync Schedule

Manual sync — Click Sync Now on the Configuration tab to immediately ingest all updates from Confluence Cloud. Manual Sync Scheduled sync — Enable Schedule Sync and set the date, time, and frequency to keep content automatically up to date. Scheduled Sync

Access Control

Search AI supports access control for content ingested via the Confluence Cloud Connector. Go to the Permissions and Security tab and select the access mode:
  • Permission Aware — Honors user permissions from Confluence Cloud. Users can only view search results for content they can access in Confluence.
  • Public Access — Overrides Confluence permissions. All users can access all ingested content regardless of their Confluence permissions.

Prerequisites

Access control relies on user email addresses as unique identifiers. The account used to configure the connector must be able to view user email addresses. Use an admin account or ensure users have enabled the required settings in their Confluence profiles. Prerequisite

Permission Sets in Confluence Cloud

Space Permissions — Each space has an independent set of permissions managed by space administrators. Search AI requires at minimum view permission to allow a user to access the content. Space Permissions Page Restrictions — Pages inherit space permissions but can define their own restrictions. If a page is set to “Only specific people can view & edit,” space permissions are not applied. Page Restrictions

How Permissions Are Handled in Search AI

  • Individual access — Users added directly to a space or page are listed in the sys_racl field of the indexed content by their email address. These users can directly access the content based on their permissions.
  • Group access — When access is granted to user groups, Search AI creates a corresponding permission entity for the group. The sys_racl field stores the permission entity IDs. Add users to the permission entity using the Permission Entity APIs to grant access.

Limitation

Anonymous access is not supported. If a page allows anonymous access in Confluence Cloud, Search AI does not permit viewing that content.