# HiBob HRIS directory sync

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

Create a HiBob API service user that can read employee data, enter its ID and token in this setup, and we read your people every few minutes.

:::caution[Verification]
Not yet verified on a real HiBob tenant. It was written from the public HiBob 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="service-user"></a>

### Create an API service user

As a Bob admin, create an API service user for OhAuthCat. Copy its ID and token when they are shown; the token is shown only once.

</li>

<li class="idp-step">

<a id="permissions"></a>

### Give the service user read access

Add the service user to a permission group. Under People's data, grant View on the Default Employee Fields (the root, about, employment and work categories). Grant nothing that edits data.

</li>

<li class="idp-step">

<a id="access"></a>

### Choose whose data it can read

Under Access data for, keep everyone you want to sync. The default condition, Lifecycle status equals Any, covers all employees.

</li>

<li class="idp-step">

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

### Enter the credentials in this setup

Enter the service user ID and token. We search your people once to check them before saving them encrypted; if the check fails, nothing is saved.

Fixes: [`directory_source_credentials_invalid`](/errors/directory_source_credentials_invalid/), [`directory_source_unavailable`](/errors/directory_source_unavailable/)

</li>

<li class="idp-step">

<a id="preview"></a>

### Preview the first sync

Select Preview to see who would be added, updated and removed, without changing anything.

</li>

<li class="idp-step">

<a id="interval"></a>

### Choose how often we read HiBob

We read HiBob every 5 minutes by default. You can set any interval from 5 minutes to 24 hours. 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

Every sync reads the full list of people. People who leave, or whom the service user can no longer see, are removed from the directory, and departments become groups.

</li>

</ol>

## Sources

- [API Service users (HiBob)](https://apidocs.hibob.com/docs/api-service-users), read on 2026-10-30
- [Permissions (HiBob)](https://apidocs.hibob.com/reference/permissions), read on 2026-10-30
