Rippling Directory Sync
Learn about syncing your user list with Rippling
This guide outlines how to synchronize your application's Rippling directories.
To synchronize an Enterprise's users and groups provisioned for your application, you'll need the following information from the Enterprise:
- Rippling API key
1Create an API Key
The Enterprise will need to create an API key for you. An API key can be generated from the Company Settings menu.
When prompted for permissions, WorkOS will require at least the following permissions:
- Company Teams
- Company Departments
- Employee First name, last name
- Employee Department
- Read Employee Department Id
- Employee Teams
- Employee Work Email
Any other information needed by your application may require additional permissions.
2Create your Directory Sync Connection
Login to your WorkOS dashboard and select "Organizations" from the left hand Navigation bar
Select the Organization you'd like to enable a Rippling Directory Sync connection for.
On the Organization's page click "Add Directory".
You'll be prompted to enter the Company's Name, Domain, and additionally select "Rippling" from the "Directory Type Dropdown"
Then click "Create Connection"
3Setup your Directory Sync Connection
Input your Enterprise's Rippling API Key.
Then, click "Update Directory".
4Assign Users and Groups to Your Application
Now, whenever your Enterprise customer assigns users or groups to your application, you'll receive Dashboard updates based on changes in their directory.
Simply browse to the "Users" tab on the Rippling Directory Sync page.