Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

https://www.googleapis.com/auth/userinfo.email
google_id_token-a99f12e0

View your email address

https://www.googleapis.com/auth/userinfo.email
google_id_token_legacy-a99f12e0

View your email address

Query Parameters

domain
string

The domain

securityCode
string

The security code

Body

application/json
accessRestrictionMode
enum<string>

The access restriction mode for the domain.

Available options:
OPEN,
LICENSED_ONLY
billingType
enum<string>

The billing mode: TRIAL, STANDARD, CUSTOM (read-only field)

Available options:
TRIAL,
STANDARD,
CUSTOM
documentationUrl
string

The URL for documentation links

domainAdmin
string

The email of the G Suite super administrator account

domainOwner
string

Used for Microsoft domains

domainType
enum<string>

The type of the domain, e.g., GOOGLE_WORKSPACE, MICROSOFT, etc.

Available options:
GOOGLE_WORKSPACE,
NON_GOOGLE_WORKSPACE
kind
string
libraryCreators
object[]

The list of users who can create libraries in the domain, if libraryCreatorsSource = SPECIFIC_USERS

libraryCreatorsSource
enum<string>

The mode for library creators audience: ANYONE (anyone of the domain or whitelisted), ONLY_SUPERADMINS (only G Suite super administrators), SPECIFIC_USERS (explicit list in 'libraryCreators' field)

Available options:
ANYONE,
ONLY_SUPERADMINS,
SPECIFIC_USERS
limitLibraryAdminAccess
boolean

Whether administrators of libraries should have a limited access to the library administration page (only applicable for Team Folder and Secured Folder libraries though)

maxSeats
integer<int32>

The maximum number of licensed users (0 means unlimited) (read-only field)

notify
boolean

Whether to notify the AODocs super administrators when pool of available licenses gets low

scriptAdmins
object[]

The list of users who are AODocs script administrators (allowed to manage domain custom scripts)

standalone
boolean
subscriptionId
string

The technical identifier for the subscription to AODocs (read-only field)

superAdmins
object[]

The list of users who are AODocs super administrators if superAdminsSource = AODOCS

superAdminsSource
enum<string>

The mode for super administrators audience: GOOGLE_APPS (implicitely G Suite super admins) or AODOCS (explicit list in 'superAdmins' field)

Available options:
GOOGLE_APPS,
AODOCS
supportUrl
string

The URL to redirect support request to

useDelayedVersion
boolean
whitelistedDomains
object[]

The list of whitelisted G Suite domains, i.e. users from those domain may access content in your libraries

whitelistedEmails
object[]

The list of whitelisted Google accounts (gmail, single G Suite account or Google groups of your domain) who may access content in your libraries

Response

200 - application/json

A ApiDomain response

accessRestrictionMode
enum<string>

The access restriction mode for the domain.

Available options:
OPEN,
LICENSED_ONLY
billingType
enum<string>

The billing mode: TRIAL, STANDARD, CUSTOM (read-only field)

Available options:
TRIAL,
STANDARD,
CUSTOM
documentationUrl
string

The URL for documentation links

domainAdmin
string

The email of the G Suite super administrator account

domainOwner
string

Used for Microsoft domains

domainType
enum<string>

The type of the domain, e.g., GOOGLE_WORKSPACE, MICROSOFT, etc.

Available options:
GOOGLE_WORKSPACE,
NON_GOOGLE_WORKSPACE
kind
string
libraryCreators
object[]

The list of users who can create libraries in the domain, if libraryCreatorsSource = SPECIFIC_USERS

libraryCreatorsSource
enum<string>

The mode for library creators audience: ANYONE (anyone of the domain or whitelisted), ONLY_SUPERADMINS (only G Suite super administrators), SPECIFIC_USERS (explicit list in 'libraryCreators' field)

Available options:
ANYONE,
ONLY_SUPERADMINS,
SPECIFIC_USERS
limitLibraryAdminAccess
boolean

Whether administrators of libraries should have a limited access to the library administration page (only applicable for Team Folder and Secured Folder libraries though)

maxSeats
integer<int32>

The maximum number of licensed users (0 means unlimited) (read-only field)

notify
boolean

Whether to notify the AODocs super administrators when pool of available licenses gets low

scriptAdmins
object[]

The list of users who are AODocs script administrators (allowed to manage domain custom scripts)

standalone
boolean
subscriptionId
string

The technical identifier for the subscription to AODocs (read-only field)

superAdmins
object[]

The list of users who are AODocs super administrators if superAdminsSource = AODOCS

superAdminsSource
enum<string>

The mode for super administrators audience: GOOGLE_APPS (implicitely G Suite super admins) or AODOCS (explicit list in 'superAdmins' field)

Available options:
GOOGLE_APPS,
AODOCS
supportUrl
string

The URL to redirect support request to

useDelayedVersion
boolean
whitelistedDomains
object[]

The list of whitelisted G Suite domains, i.e. users from those domain may access content in your libraries

whitelistedEmails
object[]

The list of whitelisted Google accounts (gmail, single G Suite account or Google groups of your domain) who may access content in your libraries