G Suite Directory Sync
Learn about syncing your user list with G Suite
This guide outlines how to synchronize your application's Google Workspace 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.
1Set up your directory sync endpoint
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 "Add Directory"
Input your Enterprise's name and domain, and select "GSuite Directory" from the "Directory Type" dropdown.
Then, click "Create Connection".
2Provide the enterprise with a setup URL
Upon creation, your endpoint will have a setup URL of the form:
Forward this URL to enterprise customers.
3Authenticate with admin credentials
Have the Enterprise choose Google as a provider and authenticate with admin credentials.
4Assign users and groups to your application
Changes will appear live in the Directory Sync portal under the 'Users' tab: