Google Workspace sync
You can sync users and groups into HelloID from a Google Workspace tenant, by registering HelloID as an OAuth client so it can make calls to the Google Workspace API.
To get started, Enable sync.
After Google Workspace sync has been enabled, a full sync is automatically performed once per night. During the day, incremental synchronizations occur in response to any user data updates in Google Workspace. This includes everything except group membership changes (due to a limitation in the API).
If you need to force a full update during the day, click the Force Synchronization button. Alternately, editing a user in Google Workspace (e.g., editing one of their user attributes) will cause their group memberships to be immediately synced to HelloID.
Tip
If you want synced Google Workspace users to be able to log in to HelloID using their Google credentials, you must separately set up a Google Workspace (SAML) IdP.
Google Workspace sync settings reference
- Client ID
Should be filled in with the Client ID value from your OAuth web app registration in the Google Cloud Platform console.
- Client Secret
Should be filled in with the Client Secret value from your OAuth web app registration in the Google Cloud Platform console.
- Domain Validation ID
Should be filled in with the name of the HTML verification file supplied by Google Webmaster Central, after providing your Domain Verification URL.
- Redirect URI
Used to complete your OAuth web app registration in the Google Cloud Platform console.
- Domain Verification URL
Used to verify HelloID in Google Webmaster Central.
- Scope
Should be set to Customer, and the text field should be filled in with the Customer ID the from Google Admin console.
- User Hard Delete
By default, the Google Workspace sync feature will soft delete users & groups in HelloID when the corresponding user or group is deleted in Google Workspace. When this toggle is enabled, users will be hard deleted instead of soft deleted. See Hard deleted users.
- Authentication Status
Red when synchronization is disabled; green when synchronization is enabled.
- Force Synchronization
Immediately performs a full synchronization of users and groups from Google Workspace into HelloID.