> ## Documentation Index
> Fetch the complete documentation index at: https://www.c1.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Set up an Atlassian Confluence connector

> C1 provides identity governance for Confluence. Integrate your Confluence instance with C1 to run user access reviews (UARs) and enable just-in-time access requests.

<Tip>
  **This is an updated and improved version of the Confluence connector!** If you're setting up Confluence with C1 for the first time, you're in the right place.
</Tip>

## Capabilities

| Resource          | Sync                                                          | Provision                                                     |
| :---------------- | :------------------------------------------------------------ | :------------------------------------------------------------ |
| Accounts          | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |                                                               |
| Groups            | <Icon icon="square-check" iconType="solid" color="#c937ae" /> | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |
| Spaces            | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |                                                               |
| Space permissions | <Icon icon="square-check" iconType="solid" color="#c937ae" /> | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |

<Tip>
  To limit sync times, a limited list of Spaces entitlements and their associated grants are synced. See the [Spaces entitlements synced by default](/baton/confluence#spaces-entitlements-synced-by-default) section of this page for more information.
</Tip>

## Gather Confluence credentials

Configuring the connector requires you to pass in credentials generated in Confluence. Gather these credentials before you move on.

<Warning>
  **Important**

  A user with **Administrator** access in Confluence must perform this task.
</Warning>

### Create an API token

<Steps>
  <Step>
    Log into your Confluence account with Administrator access.
  </Step>

  <Step>
    Navigate to [https://id.atlassian.com/manage-profile/security/api-tokens](https://id.atlassian.com/manage-profile/security/api-tokens).
  </Step>

  <Step>
    Click **Create API token**.
  </Step>

  <Step>
    Give your token a label, such as **C1**, and click **Create**.
  </Step>

  <Step>
    Carefully copy and save the newly generated API token.
  </Step>
</Steps>

**Done.** Next, move on to the connector configuration instructions.

## Configure the Confluence connector

<Warning>
  **To complete this task, you'll need:**

  * The **Connector Administrator** or **Super Administrator** role in C1
  * Access to the set of Confluence credentials generated by following the instructions above
</Warning>

<Tabs>
  <Tab title="Cloud-hosted">
    **Follow these instructions to use a built-in, no-code connector hosted by C1.**

    <Steps>
      <Step>
        In C1, navigate to **Integrations** > **Connectors** and click **Add connector**.
      </Step>

      <Step>
        Search for **Confluence v2** and click **Add**.
      </Step>

      <Step>
        Choose how to set up the new Confluence connector:

        * Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren't yet managed with C1)
        * Add the connector to a managed app (select from the list of existing managed apps)
        * Create a new managed app
      </Step>

      <Step>
        Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of C1 users. Setting multiple owners is allowed.
        If you choose someone else, C1 will notify the new connector owner by email that their help is needed to complete the setup process.
      </Step>

      <Step>
        Click **Next**.
      </Step>

      <Step>
        Find the **Settings** area of the page and click **Edit**.
      </Step>

      <Step>
        Enter your Confluence domain (the URL of your Confluence instance is `<YOUR DOMAIN>.atlassian.net`) into the **Confluence site domain** field.
      </Step>

      <Step>
        Enter the username for your Confluence account in the **Username** field.
      </Step>

      <Step>
        Paste the API token into the **API key** field.
      </Step>

      <Step>
        **Optional.** If want to sync information on Confluence users' personal spaces and their permissions, uncheck the **Skip syncing personal spaces and their permissions** box.
      </Step>

      <Step>
        Click **Save**.
      </Step>

      <Step>
        The connector's label changes to **Syncing**, followed by **Connected**. You can view the logs to ensure that information is syncing.
      </Step>
    </Steps>

    **Done.** Your Confluence connector is now pulling access data into C1.
  </Tab>

  <Tab title="Self-hosted">
    Follow these instructions to use the [Confluence](https://github.com/conductorone/baton-confluence) connector, hosted and run in your own environment.

    When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with C1, automatically syncing and uploading data at regular intervals. This data is immediately available in the C1 UI for access reviews and access requests.

    ### Resources

    * [Official download center](https://dist.conductorone.com/ConductorOne/baton-confluence): For stable binaries (Windows/Linux/macOS) and container images.

    * [GitHub repository](https://github.com/conductorone/baton-confluence): Access the source code, report issues, or contribute to the project.

    ### Step 1: Set up a new Confluence connector

    <Steps>
      <Step>
        In C1, navigate to **Integrations** > **Connectors** > **Add connector**.
      </Step>

      <Step>
        Search for **Baton** and click **Add**.
      </Step>

      <Step>
        Choose how to set up the new Confluence connector:

        * Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren't yet managed with C1)
        * Add the connector to a managed app (select from the list of existing managed apps)
        * Create a new managed app
      </Step>

      <Step>
        Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of C1 users. Setting multiple owners is allowed.

        If you choose someone else, C1 will notify the new connector owner by email that their help is needed to complete the setup process.
      </Step>

      <Step>
        Click **Next**.
      </Step>

      <Step>
        In the **Settings** area of the page, click **Edit**.
      </Step>

      <Step>
        Click **Rotate** to generate a new Client ID and Secret.

        Carefully copy and save these credentials. We'll use them in Step 2.
      </Step>
    </Steps>

    ### Step 2: Create Kubernetes configuration files

    Create two Kubernetes manifest files for your Confluence connector deployment:

    #### Secrets configuration

    ```yaml expandable theme={"theme":{"light":"css-variables","dark":"css-variables"}}
    # baton-confluence-secrets.yaml
    apiVersion: v1
    kind: Secret
    metadata:
      name: baton-confluence-secrets
    type: Opaque
    stringData:
      # C1 credentials
      BATON_CLIENT_ID: <C1 client ID>
      BATON_CLIENT_SECRET: <C1 client secret>

      # Confluence credentials
      BATON_DOMAIN_URL: <Confluence site domain URL (for example, https://your-domain.atlassian.net)>
      BATON_USERNAME: <Username for your Confluence account>
      BATON_API_KEY: <Confluence API token>

      # Optional: include if you want C1 to provision access using this connector
      BATON_PROVISIONING: true

      # Optional: include to skip syncing personal spaces and their permissions
      BATON_SKIP_PERSONAL_SPACES: true
    ```

    See the connector's README or run `--help` to see all available configuration flags and environment variables.

    #### Deployment configuration

    ```yaml expandable theme={"theme":{"light":"css-variables","dark":"css-variables"}}
    # baton-confluence.yaml
    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: baton-confluence
      labels:
        app: baton-confluence
    spec:
      selector:
        matchLabels:
          app: baton-confluence
      template:
        metadata:
          labels:
            app: baton-confluence
            baton: true
            baton-app: confluence
        spec:
          containers:
          - name: baton-confluence
            image: ghcr.io/conductorone/baton-confluence:latest
            imagePullPolicy: IfNotPresent
            env:
            - name: BATON_HOST_ID
              value: baton-confluence
            envFrom:
            - secretRef:
                name: baton-confluence-secrets
    ```

    ### Step 3: Deploy the connector

    <Steps>
      <Step>
        Create a namespace in which to run C1 connectors (if desired), then apply the secret config and deployment config files.
      </Step>

      <Step>
        Check that the connector data uploaded correctly. In C1, click **Apps**. On the **Managed apps** tab, locate and click the name of the application you added the Confluence connector to. Confluence data should be found on the **Entitlements** and **Accounts** tabs.
      </Step>
    </Steps>

    **Done.** Your Confluence connector is now pulling access data into C1.
  </Tab>
</Tabs>

## Spaces entitlements synced by default

Each Confluence Space has its own set of permissions and allowed actions, which can result in a very large set of entitlement and grant access information in each Space. In order to reduce sync times, the Confluence connector only syncs a limited set of Spaces entitlements.

By default, the Confluence connector syncs entitlements formed by valid pairs of the following targets (nouns) and operators (verbs), such as `administer-space` or `read-space`.

Default targets (nouns): `space`

Default operators (verbs): `administer`, `create`, `delete`, `export`, `read`, `restrict_content`

All available targets (nouns):

* `attachment`
* `blogpost`
* `comment`
* `page`
* `space`

All available operators (verbs):

* `administer`
* `archive`
* `create`
* `delete`
* `export`
* `read`
* `restrict_content`
* `update`

Not all target-operator (noun-verb) pairs are valid.

To change or limit what the Confluence connector syncs to C1, use the `--noun` and `--verb` flags when setting up the Confluence connector in self-hosted mode. See the [baton-confluence repo's README](https://github.com/conductorone/baton-confluence) for more information.