Oxelone Docs

Search docs and API

Find a guide, a section of one, or an API operation by its name.

Open console (opens in a new tab)

Connectors Google Workspace

Google Workspace

The Google Workspace connector reads your directory, sign-in and grant activity, Drive sharing, Alert Center and Gemini use across a domain. It reads as a named super administrator through domain-wide delegation. How the connect flow works is on How connectors work.

Who can do it

Connecting needs connections:manage (Manage connections), held by Owner, Admin and Fleet operator. In Google, a super administrator of the domain has to authorise the client ID in the Admin console. Every read is made as that person.

Connect

  1. Go to Collection › Connectors and choose Connect on Google Workspace.
  2. Give the connection a Name, and choose Modes (at least one):
    • Google Workspace: directory, sign-in and token activity, Drive sharing, Alert Center and admin-console settings.
    • Gemini: who used Gemini, where and how, and whether the Gemini app is on for an organisational unit.
  3. Choose a sign-in method:
    • Authorise Oxelone's service account in the Google Admin console. The step shows a Client ID and the Scopes to copy. The hint reads "Security › Access and data control › API controls › Manage Domain Wide Delegation › Add new: paste the client ID and every scope, authorise as a super administrator, then sign in here straight away — Google says the change usually takes minutes and can take up to 24 hours."
    • Your own service account key (JSON). Upload a service account key you own, with domain-wide delegation for the same scopes. The hint reads "A service account of your own with domain-wide delegation for the same scopes; name the super administrator it runs as beside it."
  4. Enter the Super administrator's address (the placeholder is admin@example.com). The line under it reads "Every read is made as this person, who has to be a super administrator of the domain." Sign in stays off until you do: "Name the super administrator first."
  5. Continue through Check and Rules, then choose Create connection.

On Google's side

Google's steps for domain-wide delegation: in the Admin console go to Menu › Security › Access and data control › API controls, select Manage Domain Wide Delegation, click Add new, enter the service account's client ID, add each OAuth scope, and click Authorize. Google then says "Changes can take up to 24 hours but typically happen more quickly." If multi-party approval is on, another super admin must approve.

Vendor documentation: https://knowledge.workspace.google.com/admin/apps/control-api-access-with-domain-wide-delegation

The scopes to paste, for Oxelone's service account and your own:

  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/admin.directory.group.readonly
  • https://www.googleapis.com/auth/admin.directory.group.member.readonly
  • https://www.googleapis.com/auth/admin.directory.orgunit.readonly
  • https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly
  • https://www.googleapis.com/auth/admin.directory.domain.readonly
  • https://www.googleapis.com/auth/admin.directory.customer.readonly
  • https://www.googleapis.com/auth/admin.directory.user.security
  • https://www.googleapis.com/auth/admin.reports.audit.readonly
  • https://www.googleapis.com/auth/apps.alerts
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/cloud-identity.policies.readonly
  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.group.member
  • https://www.googleapis.com/auth/drive

The last three are for actions. The console shows the exact list to copy.

What it reads

Mode: Google Workspace

RecordsWhat you get
PeopleEvery account in the directory: administrator status, suspension, two-step verification and organisational unit.
GroupsEvery group, its address and how many direct members it has.
Group membersWho is in each group, and as what.
Organisational unitsThe organisational-unit tree settings are scoped by.
Administrator rolesThe roles an administrator can hold, and which are super-administrator roles.
Role assignmentsWho holds which administrator role, and over what.
DomainsThe customer's domains and whether each is verified.
Third-party app grantsEvery OAuth grant a person has given a third-party application, with its scopes. The first 2,000 people, by address.
App passwordsApplication-specific passwords, and when each was last used. The first 2,000 people, by address.
Sign-in eventsSign-ins, failures, challenges and 2-step verification changes, as they happen.
Third-party grant eventsEvery authorisation, revocation and request of a third-party application, as it happens.
Admin console changesEvery setting an administrator changed, including the security and application settings this connector cannot read directly.
Drive eventsDrive activity as it happens: which file, its owner, and how visible it is.
Alert Center alertsGoogle's own security alerts: leaked passwords, suspicious sign-ins, phishing, DLP violations, admin changes.
Admin console settingsThe settings the Policy API exposes: 2-step verification enforcement, Drive external sharing, Chat restrictions.
Shared drivesEvery shared drive in the domain, and the restrictions on it.
Drive filesFiles each person owns (read as that person, the first 200 people, up to 500 files each) and every shared drive holds, with how widely each is shared. Nothing is opened.
Drive changesWhat changed in each person's Drive since the last sync, read as that person. The first 200 people, by address.

Mode: Gemini

RecordsWhat you get
Gemini activityWho used Gemini, in which app, through which feature. Never what was asked.
Gemini app settingsWhether the Gemini app and NotebookLM are on, per organisational unit or group.

What it can do

ActionConsequenceReversible
Suspend the personThe person is signed out and cannot sign in until an administrator unsuspends them.Yes
Sign out everywhereEvery web and device session ends and the person has to sign in again.No
Revoke the application's accessThe application loses every access token this person granted it.No
Revoke the app passwordThe app password stops working; the person makes a new one if they still need it.No
Remove from the groupThe person loses whatever this group grants.No
Remove the link or outside shareThe file stops being reachable through the link, or by the person or domain outside yours.No

What it checks

Nineteen posture checks, no inspections.

RuleSeverityAction offered
Person without 2-step verificationHighNone
2-step verification not enforced for a personMediumNone
Super administratorLowNone
Suspended person with a third-party grantMediumRevoke the application's access
Grant to an application not registered with GoogleMediumRevoke the application's access
Grant with full Drive accessMediumNone
App password unused for 90 daysLowRevoke the app password
File open to anyone with the linkHighRemove the link or outside share
File shared outside the domainMediumRemove the link or outside share
Unverified domainLowNone
Gemini app onLowNone
NotebookLM onLowNone
2-step verification not enforcedHighNone
Drive external sharing allowedMediumNone
Suspicious sign-inHighNone
2-step verification turned offMediumNone
2-step verification setting changedMediumNone
Third-party application trustedMediumNone
High-severity Alert Center alertHighNone

What it needs to be Readable

The domain must have authorised the client ID for the scopes above, and the Super administrator you named must be a super administrator there. A kind the scopes do not reach shows Not readable with its reason on Check.

Sync period

1 h, 6 h and 1 d. There is no 15-minute period.

When it goes wrong

What you seeWhat it means
the domain of address has not authorised Oxelone's service account for the scope it asked, or address is not a super administrator there. Nothing was changed. Authorise the client ID with every scope under Manage Domain Wide Delegation, wait a few minutes, and try again.Google refused the delegated sign-in. address is the super administrator you named. With your own key file it reads "this service account" in place of "Oxelone's service account".
A global admin has not registered the sign-in client Google needs to prove who is connecting, so Oxelone's service account is not offered for Google Workspace. Connect with your own service account's key file instead.Oxelone's service account cannot be used yet.
Name the super administrator first.Sign in is off until the field is filled.

With the API

Not available with an API key.