Google Directory Sync

This guide outlines how to synchronize your application’s Google Workspace directories.

Login to your WorkOS dashboard and ensure you have the desired environment selected.

Select “Organizations” in the navigation.

Select the organization that’d like to enable a Google Directory Sync connection.

On the Organization page, under “Invite an admin to set up this organization,” select “Invite Admin.”

Select “Directory Sync” and any other features you’d like the organization to be able to onboard.

Enter the email address of the organization admin, or copy the setup link and send it to the organization admin.

Have the organization choose Google as a provider and follow the Google prompts to authenticate with admin credentials.

The organization admin can then select to filter which groups and memberships are synced to the directory. If groups are being filtered, then only users with a membership within one of the synced groups will be synced.

Changes will appear live in the Directory Sync portal under the “Users” tab:

A detailed guide to integrate the WorkOS API with your application can be found here

Can you selectively sync users and groups from Google Workspace?

You can select to sync certain groups during setup within the Admin Portal as seen in Step 4.

When do users get removed from a directory?

There are 2 ways a user can be deleted from a Google Workspace directory.

How often do Google Workspace directories perform a sync?

Google Workspace directories poll every 30 minutes starting from the time of the initial sync