# Rippling HRIS directory sync

<!-- Generated by scripts/generate.ts. Do not edit. -->

Create a Rippling API token that can read your employees, enter it in this setup, and we read your employee list every few minutes.

:::caution[Verification]
Not yet verified on a real Rippling tenant. It was written from the public Rippling documentation, so labels in the admin console may differ slightly.
:::

The values in braces, such as `{acs_url}`, are specific to your connection. The setup link from the application you are connecting shows them with a copy button. The same steps appear there.

## Steps

<ol class="idp-steps">

<li class="idp-step">

<a id="choose"></a>

### Choose directory sync from the HRIS

Use this guide when you want this app to read people straight from Rippling's employee records. If you manage app access with Rippling's SCIM provisioning instead, follow the Rippling SCIM guide.

</li>

<li class="idp-step">

<a id="api-token"></a>

### Create an API token

As a Rippling admin, create an API token in Rippling's API access settings with read access to employee records. Copy the token when it is shown.

:::caution[Labels not confirmed in step 2]
No public Rippling page was checked for where admins create API tokens or which scope names they offer.
:::

</li>

<li class="idp-step">

<a id="credentials"></a>

### Enter the credentials in this setup

Paste the API token in this setup. We check it with one read from Rippling before saving it encrypted; if the check fails, nothing is saved.

</li>

<li class="idp-step">

<a id="first-sync"></a>

### Wait for the first sync

The first sync starts right away. After that we read Rippling every 5 minutes; after a failure we wait longer between tries, up to an hour.

</li>

<li class="idp-step">

<a id="who"></a>

### Know who is synced

We read the full employee list on every sync. People Rippling no longer returns are removed from the directory, and changes to names, titles or departments are updated.

</li>

<li class="idp-step">

<a id="rotate"></a>

### Replace the credentials when needed

If you revoke the token or it expires, syncs fail and this setup shows the error. Create a new token and enter it here again.

</li>

<li class="idp-step">

<a id="check"></a>

### Check the first users

After the first sync, check in this setup that the people you expect are listed with the right names and emails.

</li>

</ol>

## Sources

- [Rippling developer documentation](https://developer.rippling.com/documentation), read on 2026-10-29
