> ## Documentation Index
> Fetch the complete documentation index at: https://conductorone-docs-baton-kubernetes.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Set up an Outline connector

> C1 provides identity governance for Outline. Integrate your Outline instance with C1 for unified visibility and governance over user access.

C1 provides identity governance for Outline. Integrate your Outline
instance with C1 for unified visibility and governance over user access.

## Capabilities

| Resource | Sync                                                          | Provision |
| -------- | ------------------------------------------------------------- | --------- |
| Users    | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |           |
| Groups   | <Icon icon="square-check" iconType="solid" color="#c937ae" /> |           |

The connector syncs Outline **workspace users**, **groups**, and **group
memberships**. Each group exposes a member entitlement, and each group
membership becomes a grant of that entitlement to the member.

## Gather Outline credentials

<Warning>
  The connector authenticates with an Outline **API key**. Use an unscoped key
  created by a workspace admin, or a key scoped to `users.list`, `groups.list`,
  and `groups.memberships`.
</Warning>

<Steps>
  <Step>
    In Outline, open **Settings** > **API & Apps** and create a new API key.
  </Step>

  <Step>
    If you scope the key, include the `users.list`, `groups.list`, and
    `groups.memberships` scopes so the connector can list workspace users,
    groups, and group memberships.
  </Step>

  <Step>
    Copy the key value, and note your Outline URL. For Outline's hosted
    service this is `https://app.getoutline.com`; for a self-hosted Outline
    server, use the URL the server is reachable at, with no trailing slash
    and no path.
  </Step>
</Steps>

## Configuration fields

| Field      | Required | Description                                                                                                          |
| ---------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
| `base-url` | Yes      | The URL of your Outline installation, with no trailing slash and no path (for example `https://app.getoutline.com`). |
| `api-key`  | Yes      | An Outline API key, sent as a bearer token. It must be able to list users and groups.                                |

## Synced resource types

* **Users**: Outline workspace users, including suspended and invited users.
  Suspended or deleted users sync as disabled.
* **Groups**: Outline groups, each with a **member** entitlement.
* **Group memberships** (as grants): each group's members, granted the
  group's member entitlement.

## Special notes

* Provisioning is not supported in the current build; the connector is
  read-only.
* Collections and documents are not synced; the connector covers workspace
  identity and group membership.
* The connector requests users of every status. If your Outline server
  excludes suspended or invited users from those listings, those users will
  not appear in C1 until they are active.

## Configure the Outline connector

<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 **Outline** and click **Add**.
      </Step>

      <Step>
        Choose how to set up the new Outline connector.
      </Step>

      <Step>
        Set the owner for this connector.
      </Step>

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

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

      <Step>
        Enter the Outline credentials:

        * **Outline URL**: The URL of your Outline installation.
        * **API key**: The API key created in Settings > API & Apps.
      </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 Outline connector is now pulling access data into C1.
  </Tab>

  <Tab title="Self-hosted">
    Follow these instructions to run the Outline connector in your own
    environment.

    <Steps>
      <Step>
        Create secrets for the Outline credentials.
      </Step>

      <Step>
        Configure the connector environment variables:

        * **`BATON_BASE_URL`**: The URL of your Outline installation.
        * **`BATON_API_KEY`**: The API key created in Settings > API & Apps.
      </Step>

      <Step>
        Deploy the connector using your standard self-hosted connector process.
      </Step>
    </Steps>

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