> ## 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 Whimsical connector

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

## Capabilities

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

The Whimsical connector syncs users and roles via the SCIM 2.0 API.

This connector supports the following provisioning operations:

* **User account provisioning**: Create new users via SCIM POST
* **User account deletion**: Remove users from the workspace via SCIM DELETE
* **Role provisioning**: Assign and revoke Editor or Viewer roles via SCIM PATCH (grant/revoke)

## Requirements

* A Whimsical **Enterprise** plan with **SAML SSO** enabled
* A **SCIM OAuth token** from workspace settings

## Gather Whimsical credentials

### Obtain a SCIM OAuth token

<Steps>
  <Step>
    Log in to [Whimsical](https://whimsical.com/) as a workspace administrator.
  </Step>

  <Step>Click on the **workspace name** in the top left corner.</Step>
  <Step>Navigate to **Workspace settings**.</Step>
  <Step>Ensure **SAML SSO** is enabled and correctly configured.</Step>
  <Step>Enable **SCIM provisioning**.</Step>
  <Step>Click **Reveal** to retrieve the OAuth token.</Step>
  <Step>Copy the token immediately.</Step>
</Steps>

See the [Whimsical SCIM documentation](https://help.whimsical.com/security/entra-scim) for detailed instructions.

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

## Configure the Whimsical connector

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

  * The **Connector Administrator** or **Super Administrator** role in C1
  * Your Whimsical SCIM OAuth token generated 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 **Whimsical** and click **Add**.
      </Step>

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

        * Add the connector to a currently unmanaged app
        * Add the connector to a managed app
        * Create a new managed app
      </Step>

      <Step>
        Set the owner for this connector and click **Next**.
      </Step>

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

      <Step>
        Paste the SCIM OAuth **Token**.
      </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 Whimsical connector is now pulling access data into C1.
  </Tab>

  <Tab title="Self-hosted">
    **Follow these instructions to use the Whimsical 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

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

    ### Step 1: Set up a new Whimsical 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 Whimsical 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>
        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

    #### Secrets configuration

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

      # Whimsical config
      BATON_WHIMSICAL_TOKEN: <Whimsical Token>

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

    #### Deployment configuration

    ```yaml expandable theme={"theme":{"light":"css-variables","dark":"css-variables"}}
    # baton-whimsical.yaml
    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: baton-whimsical
      labels:
        app: baton-whimsical
    spec:
      selector:
        matchLabels:
          app: baton-whimsical
      template:
        metadata:
          labels:
            app: baton-whimsical
            baton: "true"
            baton-app: whimsical
        spec:
          containers:
            - name: baton-whimsical
              image: ghcr.io/conductorone/baton-whimsical:latest
              imagePullPolicy: IfNotPresent
              env:
                - name: BATON_HOST_ID
                  value: baton-whimsical
              envFrom:
                - secretRef:
                    name: baton-whimsical-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 whimsical connector to. whimsical data should be found on the **Entitlements** and **Accounts** tabs.
      </Step>
    </Steps>

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

***

<Tip>
  All versions of this connector are available at
  [dist.conductorone.com](https://dist.conductorone.com/ConductorOne/baton-whimsical).
</Tip>