> ## 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 a Rippling connector

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

## Capabilities

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

## Gather Rippling credentials

Each setup method requires you to pass in credentials generated in Rippling. Gather these credentials before you move on.

<Warning>
  A user with the user permissions to view all users and teams in Rippling must perform this task.
</Warning>

### Generate an API token

<Steps>
  <Step>
    In Rippling, navigate to **Company Settings** > **API Tokens**.
  </Step>

  <Step>
    Give the new token a name, such as "C1", and set the token's unique identifier and API version.
  </Step>

  <Step>
    Configure the scopes for the API token, giving it the permission to view all Rippling users and teams.
  </Step>

  <Step>
    Create the token, then carefully copy and save the token value.
  </Step>
</Steps>

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

## Configure the Rippling connector

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

  * The **Connector Administrator** or **Super Administrator** role in C1
  * Access to the set of Rippling 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 **Rippling** and click **Add**.
      </Step>

      <Step>
        Choose how to set up the new Rippling 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 token into the **API token** field.
      </Step>

      <Step>
        Optionally, configure additional sync settings:

        * **Expand department**: Include department data in worker sync. Requires the `departments.read` scope.
        * **Expand employment type**: Include employment type data. Requires the `employment-types.read` scope.
        * **Expand level**: Include level data. Requires the `levels.read` scope.
        * **Expand work locations**: Include work location name and address. Requires the `work-locations.read` scope.
        * **Custom fields**: A list of custom field names to sync from the Rippling Workers endpoint. Only fields with names matching this list (case-insensitive) will be included in user profiles. For example, to sync scrum team data, enter `Scrum Teams` and `Scrum Team Code`. Requires the `custom_fields.read` scope.
      </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 Rippling connector is now pulling access data into C1.
  </Tab>

  <Tab title="Self-hosted">
    **Follow these instructions to use the Rippling 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-rippling): Access the source code, report issues, or contribute to the project.

    ### Step 1: Configure the Rippling 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 Rippling 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 Rippling connector deployment:

    #### Secrets configuration

    ```yaml theme={"theme":{"light":"css-variables","dark":"css-variables"}}
    # baton-rippling-secrets.yaml
    apiVersion: v1
    kind: Secret
    metadata:
      name: baton-rippling-secrets
    type: Opaque
    stringData:
      # C1 credentials
      BATON_CLIENT_ID: <C1 client ID>
      BATON_CLIENT_SECRET: <C1 client secret>
      
      # Rippling credentials
      BATON_API_TOKEN: <Rippling API token>
      
      # Optional: sync specific custom fields from worker profiles
      # BATON_CUSTOM_FIELDS: "Scrum Teams,Scrum Team Code"
    ```

    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-rippling.yaml
    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: baton-rippling
      labels:
        app: baton-rippling
    spec:
      selector:
        matchLabels:
          app: baton-rippling
      template:
        metadata:
          labels:
            app: baton-rippling
            baton: true
            baton-app: rippling
        spec:
          containers:
          - name: baton-rippling
            image: ghcr.io/conductorone/baton-rippling:latest
            imagePullPolicy: IfNotPresent
            env:
            - name: BATON_HOST_ID
              value: baton-rippling
            envFrom:
            - secretRef:
                name: baton-rippling-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 Rippling connector to. Rippling data should be found on the **Entitlements** and **Accounts** tabs.
      </Step>
    </Steps>

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