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

# Rippling

Oleria provides identity security and access management teams with visibility and intelligence into who has access to what, where they got that access, how they use it, and whether they should even have it. As part of that promise, we integrate your Rippling HRIS into the Oleria platform as the authoritative source for employees, departments, and reporting structure. Follow these steps to connect Rippling to your Oleria workspace using an API token.

## Prerequisites

* Rippling administrator account with permission to create API tokens under Developer settings
* Admin access to the Oleria workspace

<Note>
  Use a service account (and not an individual employee's account) to create the API token. Rippling revokes the token if its owner is terminated, so a personal account puts the integration at risk of breaking unexpectedly.
</Note>

## Create an API token in Rippling

<Steps>
  <Step title="Open API Tokens">
    Log in to Rippling as an administrator, then select **Tools** -> **Developer** -> **API Tokens**.
  </Step>

  <Step title="Create a new token">
    Select **Create API token**.
  </Step>

  <Step title="Set the API version and scopes">
    Select API version **2024-08-01** and assign the following read scopes:

    ```
    companies.read
    workers.read
    users.read
    departments.read
    employment-types.read
    supergroups.read
    app-users.read
    ```

    <Note>
      To let Oleria add or remove workers from Rippling groups as a remediation action, also assign the `supergroups.read-write` scope. Without it, the integration is read-only.
    </Note>
  </Step>

  <Step title="Copy the token value">
    Save the token. Rippling displays the token value only once, so copy it now.
  </Step>
</Steps>

## Connect Rippling to Oleria

<Steps>
  <Step title="Open the integration">
    Go to your Oleria workspace, select **Integrations** -> select **Rippling**.
  </Step>

  <Step title="Complete the connection form">
    Select **Continue** and provide the following:

    | Field | Notes |
    | :- | :- |
    | API Token | Required. The token value copied from Rippling. Rippling revokes it if its owner is terminated, or after 30 days of inactivity. |
  </Step>

  <Step title="Confirm the connection">
    Select **Authenticate** to validate the token. Find the newly connected Rippling instance in your Oleria workspace connected integrations.
  </Step>
</Steps>

<Note>
  If the token is revoked, generate a new API token in Rippling and update it from the Rippling integration's edit mode in your Oleria workspace.
</Note>

## What Oleria imports from Rippling

Oleria uses Rippling as the authoritative source for your workforce identity data:

* Employees, people, and accounts, including manager relationships
* Departments and department hierarchy
* Rippling groups and group membership
* Third-party applications Rippling has provisioned for each worker, and which workers are assigned to them
* Worker change activity (hires, changes, and offboards), where your tenant has the separately licensed Worker Changes API entitlement

<Note>
  A later change to the token creator's Rippling permission profile can silently narrow what the connector can read. Rippling omits fields the token can no longer see rather than returning an error, so if data starts disappearing from Oleria, check the token owner's permissions first.
</Note>

<Note>
  Activity data (worker change events) requires Rippling's separately licensed Worker Changes API. If your tenant doesn't have that entitlement, Oleria still connects successfully, but activity data stays empty.
</Note>

## Verify the integration

Once connected, Oleria performs an initial sync of employees, departments, groups, and third-party application access from Rippling. Subsequent syncs run on Oleria's standard sync cadence and pick up changes to workers, departments, group membership, application access, and worker change activity.

## Contact us

For questions about this integration, contact us at [support@oleria.com](mailto:support@oleria.com).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.