WorkOS Docs Homepage
DashboardSign In

Google Directory Sync

Learn about syncing your user list with Google Workspace.

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

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

  • An Endpoint that Google will make requests to.

This is available in your Endpoint’s Settings in the WorkOS Dashboard.

Login to your WorkOS dashboard and browse to “Organizations” on the left hand navigation bar.

Select the organization you’d like to enable a Google Directory Sync Connection with.

From the Organization page, select “Manually Configure Directory.”

A screenshot showing where to find “Manually Configure Connection” for an Organization in the WorkOS Dashboard.

Input the organization’s name and domain, and select “Google Workspace” from the “Directory Type” dropdown.

Then, click “Create Directory”.

A screenshot showing how to create a directory in the WorkOS Dashboard.

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

Forward this URL to the organization.

A screenshot showing where to find the setup URL in the WorkOS Dashboard.

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

A screenshot showing the requested permissions in the Google modal.

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

A screenshot showing users in the "Users" tab of the WorkOS Dashboard.

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?

Google Workspace is an all or nothing scenario. You can't selectively sync certain groups. It is recommended to do filtering on your end based on groups assigned to the users if this is needed.

How often do Google Workspace directories perform a sync?

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