Directory Sync

G Suite Directory Sync

Learn about syncing your user list with G Suite

G Suite Directory Sync is not yet generally available. If you'd like preview access, please contact us.

This guide outlines how to synchronize your application's GSuite directories.

To synchronize an Enterprise's users and groups provisioned for your application, you'll need to provide the Enterprise with:

  • An Endpoint that Google will make requests to.

This is available in your Endpoint's Settings.

Step 1. Set up your directory sync endpoint.

Click "Add new endpoint".

Input your Enterprise's name and domain.

Then, click "Create endpoint."

Step 2. Provide the enterprise with a setup URL.

Upon creation, your endpoint will have a setup URL of the form:

https://directory-sync.com/setup?token=token_value

Forward this URL to enterprise customers.

Note: WorkOS owns directory-sync.com and uses this domain for setting up directory endpoints in the developer dashboard.

Step 3. Have the enterprise choose Google as a provider and authenticate with admin credentials.

Step 4. Assign users and groups to your application