---
sidebar_position: "12"
title: "Confluence"
---

## Set Up the Confluence Connector

The Confluence Connector allows you to ingest pages, subpages, and their attachments from selected Confluence spaces directly into your project.

<Note>
  The connector currently supports only text and images. Tables and videos are not supported.
</Note>

### Prerequisites

- An Atlassian account with access to the Confluence spaces you wish to ingest.

Decide on OAuth configuration - Airia managed with required scopes for all Atlassian integrations or Bring your own OAuth connector with custom scopes that best fit your integration and security requirements.

## Set Up with Airia managed OAuth

Airia Managed Atlassian OAuth connector is available for all SaaS customers. It can be found under OAuth connectors component in the Settings tab.

## Set up with your custom managed OAuth

This guide explains how to configure Confluence connector app in Atlassian and integrate it with Airia, allowing Airia to access Confluence spaces.

### Configure Your Atlassian App

#### 1. Register Your Application in Atlassian
 
1.  Go to the Atlassian **Developer console**.
2.  Sign in with your Confluence account.
3.  Click on **my apps**.
4.  Click on **Create** and choose **OAuth 2.0 integration**.
5.  Enter a name for your app.
6.  Accept the terms and conditions.
7.  Click the **create** button.

#### 2. Configure API Permissions
8.  Click on the **Permissions** menu in the left sidebar and then click **Add Confluence API**.
9.  Click the **Configure** button for **Confluence API**.
10. **Edit scopes** and select the following permissions:
   * read:attachment:confluence read:content-details:confluence read:user:confluence read:page:confluence read:confluence-space.summary read:confluence-props read:confluence-content.all read:space:confluence read:confluence-space.summary read:confluence-props read:confluence-content.all read:confluence-content.summary read:confluence-user read:confluence-groups readonly:content.attachment:confluence read:confluence-content.permission search:confluence offline_access
11. Click the **save** button.
12. Click on the **Authorization** menu in the left sidebar.
13. Click **Add authorization type**.
14. Add the **Callback URL** - https://auth.airia.ai/OAuth/callback

#### 3. Obtain Your Client Secret
 
1.  Click on the **Settings** menu in the left sidebar.
2.  Go to the **Authentication details** section.
3.  Copy the **Client Id** and **Secret** and save them securely (e.g., in Terraform).

### Create Your OAuth Connector in Airia
1.  In the Airia platform, navigate to **Settings** > **OAuth connectors**.
2.  Select the **Atlassian** card.
3.  Enter the following details for your new OAuth connector:
    *   **Name**: A descriptive name (e.g., `Confluence Connector`).
    *   **Client ID**: The Application (client) ID you saved from Azure AD (Phase 1, Step 3).
    *   **Client Secret**: The client secret value you saved from Azure AD (Phase 1, Step 3).
    *   **Scopes**: Add the following scopes (matching those configured in Atlassian in Step 2):
       *   read:attachment:confluence read:content-details:confluence read:user:confluence read:page:confluence read:confluence-space.summary read:confluence-props read:confluence-content.all read:space:confluence read:confluence-space.summary read:confluence-props read:confluence-content.all read:confluence-content.summary read:confluence-user read:confluence-groups readonly:content.attachment:confluence read:confluence-content.permission search:confluence offline_access
4.  Click **Create**.

### 1. Add a New Confluence Data Source

1.  In the Airia platform, navigate to **Available data sources**.
2.  Select the **Confluence** card.

### 2. Configure Data Source Details

1.  Provide the following details:
    *   **Name**: A mandatory, descriptive name for your data source (e.g., `Confluence Space A Data`).
    *   **Description**: (Optional) A brief description.
    *   **Scope**: Select the Airia project for this data source.
    *   **OAuth connector**: From the dropdown, select the Atlassian OAuth connector you created in Phase 3 or Airia managed OAuth.
2.  For **Credentials**, choose `Create new credential` (this is the only option if you just created the OAuth connector) or select an already existing credential.
3.  Enter a **Name** for the new credential.
4.  Confirm the required scopes for the user authenticating that match the scopes for the Oauth configuration. The required scopes for the connector to work are pre-selected and cannot be changed. More scopes can be added if the credentials is to be reused for other connectors or tools. 
5.  Click **Authenticate**. 

*** 3. Configure Confluence Spaces**
   Go to the next page and select the spaces you want to ingest.

   <Tip>
     When selecting a space, we will ingest all the content provided its content type is supported by Airia.
   </Tip>
4. **Monitor Ingestion Status**
   After providing your spaces selection, the page will refresh to display the ingestion status.
   To view a detailed status for each item, click on the data source again. The detailed list will show ingested pages and subpages marked as `json` file types, with all attachments listed as separate file types.

## Permissions Enforcement

Airia filters query results based on the end-user's access permissions in Confluence.

### Prerequisites

To enable permission enforcement for your data source:

- **Single Sign-On (SSO)** must be enabled for your Airia project.
- **Permission check** must be enabled when configuring the specific data source (e.g., when setting up the Confluence data source).

<Warning>
  Platform users with read permissions can view the files and their generated chunks within a data source in the platform UI when  it's not user-specific. Permission checking is applied only at query time, not when viewing data in the UI.
</Warning>

## Next Steps

Once the data has been successfully ingested, your Confluence data source is ready to be used with an Agent.
