Help The platform Import and SSO
Connect Google Workspace
On this page
Overview
Google Workspace is read in read-only mode: users, groups and members. This article covers the preparation on the Google side and the Connection and SSO sign-in sections; the other settings are shared by all imports.
1Prepare access at Google
The synchronization uses a Google service account that acts on behalf of an administrator of your domain. You need:
a service account in a Google Cloud project, with a JSON key (the file must contain
client_email,private_keyandtoken_uri);the Admin SDK API enabled for that project;
in the Google Workspace admin console, domain-wide delegation granted to the service account’s client ID, with exactly the three read-only scopes below;
the email address of a domain administrator who can read users and groups: the service account acts on their behalf.
Google console menus change often: search for “Service accounts” for the key and “Domain-wide delegation” for the scopes.
2Fill in the Connection section
| Field | Content |
|---|---|
| Service account JSON key | Required. The full content of the JSON file; it is the import’s secret, not to be shared anywhere else. |
| Delegated administrator email | Required. The administrator on whose behalf the service account reads the directory. |
| Google customer ID | Optional. Empty: my_customer, the delegated administrator’s account. |
| Domain | Optional. Limits the users read to this domain, for example exemple.ch. Groups are always read for the whole account. |
The JSON key contains a private key: paste it only into this field.
What is imported
- A user suspended or archived in Google is imported as inactive.
- Only direct members of the user type are attached to a group: a nested group is not expanded.
- Properties usable in field matching and filters, for a person:
primaryEmail,name.givenName,name.familyName,name.fullName,phones[0].value,organizations[0].title,orgUnitPath,languages[0].languageCode, and the other top-level fields returned by Google, for examplesuspended. - For a group:
name,email,description.
Example of a filter by organizational unit: Property orgUnitPath, Starts with, /Siège.
SSO sign-in with Google
SSO uses an OAuth application of the “web application” type created in Google Cloud, separate from the service account.
Declare all the redirect URLs shown in SSO sign-in (portal and Academy) as authorized redirect URIs of the OAuth application.
Enter the issuer
https://accounts.google.com, the client ID and client secret of the OAuth application, save, then test discovery.
Enabling SSO and the effects of an outage are described in the general article.
Test and troubleshoot
| Situation | What to check |
|---|---|
| Connection test fails | Is the JSON key complete and up to date? Does the delegation apply to this service account’s client ID, with the three scopes? Is the delegated email that of an administrator who can read users and groups? |
| The test succeeds, but some people are missing | Does the Domain field limit the reading? Are the missing people direct members of the selected groups? |
| Organization with encryption active | The test and the synchronization go through the Bexxo Protected agent: it must be started and able to reach the Google addresses. |
Didn’t find the answer? Contact us