Connect

Start a Google Workspace organization connection

Changed on

Creates an organization connection for a Google Workspace domain. A super admin then delegates Zernio's client ID with the returned scopes, and you add mailboxes without each user signing in.

Flow

  1. Add setup.dnsRecord (a TXT record) to the domain. It proves the domain's owner set up this connection.
  2. A super admin adds setup.clientId with setup.scopes under domain-wide delegation in the Admin console.
  3. Call POST /v1/org-connections/{orgConnectionId}/verify with any mailbox in the domain.
  4. Add mailboxes with POST /v1/org-connections/{orgConnectionId}/mailboxes.
post/v1/connect/google/org

Request

Request body

profileIdstring required
domainstring required

The Workspace domain the admin delegates.

scopesstring[] required

Areas the mailboxes get, the same as a user connect.

adminEmailstring email

A super admin, used to list the domain's users.

allowedEmailsstring[]

Addresses or @domain entries mailboxes must match. Omit for every mailbox.

Example request

{
  "domain": "acme.com"
}

Response

The connection, pending until verified

Changes