Allowlisted Domains API overview

The Cloud Identity Allowlisted Domains API lets workspace administrators programmatically modify or view the allowlisted domains for a Google Workspace domain.

With the Allowlisted Domains API, you can do the following:

• Add a domain to the allowlist
• Remove a domain from the allowlist
• List the domains in the allowlist
• Get a specific domain from the allowlist

Limitations

• No bulk operations: Bulk creation or deletion is not supported using a single API call.
• Concurrency: Concurrent mutations for the same customer aren't supported. Each mutation operation returns a long-running operation (LRO), wait for the existing LRO for the customer to finish before starting a new mutation.
• Pagination aborts: In the event of any domain mutations, ongoing paginated list operations will be aborted with an ABORTED error. Pagination must be restarted from the beginning.
• Scope: Initial support for the API is restricted to direct customers. Reseller-managed workflows are not supported.

What's next

• To set up Cloud Identity, see Setting up Cloud Identity.
• To set up the Allowlisted Domains API, refer to Setting up the Allowlisted Domains API.
• To add a domain to the allowlist, refer to Adding a domain to the allowlist.
• To list and retrieve domains, refer to Listing and getting allowlisted domains.
• To remove a domain from the allowlist, refer to Removing a domain from the allowlist.
• To view audit logs, refer to Viewing audit logs.