Skip to main content
New to Corsair? See API access, authentication, and error handling.

Customers

get

customers.get Read the account’s customer record, including its primary domain Risk: read
Input Output

Domains

aliases.list

domains.aliases.list List the account’s domain aliases, optionally for one parent domain Risk: read
Input The API caps an account at 20 domain aliases. Output

get

domains.get Read one domain Risk: read
Input Output

list

domains.list List the account’s domains Risk: read
Input Output

Groups

aliases.delete

groups.aliases.delete Remove an alias email address from a group Risk: destructive
Input Output: void

aliases.insert

groups.aliases.insert Add an alias email address to a group Risk: write
Input Output

aliases.list

groups.aliases.list List a group’s aliases Risk: read
Input Output

delete

groups.delete Delete a group and its memberships Risk: destructive · Irreversible
Input Output: void

get

groups.get Read one group by email, alias or ID Risk: read
Input Output

insert

groups.insert Create a group Risk: write
Input Output

list

groups.list List groups in the account, one domain, or the groups a user belongs to Risk: read
Input Output

update

groups.update Update a group’s email, display name or description Risk: write
Input Sends PATCH, so an omitted field keeps its value. Output

Members

delete

members.delete Remove a member from a group; the member loses the group’s mail and access Risk: destructive
Input Output: void

get

members.get Read one group membership Risk: read
Input Output

hasMember

members.hasMember Check whether a user is a direct or nested member of a group Risk: read
Input Output

insert

members.insert Add a user or group to a group with a role and a mail delivery preference Risk: write
Input Output

list

members.list List a group’s members, optionally including members inherited from nested groups and filtered by role Risk: read
Input roles takes a comma-separated subset of OWNER, MANAGER and MEMBER. Output

update

members.update Change a member’s role or mail delivery preference Risk: write
Input A role change alone sends PATCH. A delivery preference change sends the PUT, which replaces the role too, so pass role with delivery_settings. Output

Org Units

delete

orgUnits.delete Delete an organizational unit. It must hold no users or child units first Risk: destructive · Irreversible
Input Output: void

get

orgUnits.get Read one organizational unit Risk: read
Input The path is the full one without a leading slash, e.g. engineering/apps. Output

insert

orgUnits.insert Create an organizational unit under a parent Risk: write
Input Send parentOrgUnitPath or parentOrgUnitId; one of them is required. Output

list

orgUnits.list List organizational units: immediate children, all descendants, or all descendants plus the unit itself Risk: read
Input Output

update

orgUnits.update Rename an organizational unit or move it under another parent, which changes the settings its users inherit Risk: write
Input Output

Users

aliases.delete

users.aliases.delete Remove alias email addresses from a user; mail to a removed alias is no longer delivered Risk: destructive
Input Output: void

aliases.insert

users.aliases.insert Add an alias email address to a user Risk: write
Input Output

aliases.list

users.aliases.list List a user’s alias email addresses Risk: read
Input Output

delete

users.delete Delete a user account. The account stays recoverable through users.undelete while it is in the trash Risk: destructive
Input Output: void

get

users.get Read one user by email, alias or ID Risk: read
Input A customFieldMask is only read when projection is custom. Output

insert

users.insert Create a user account with an initial password. On a flexible Workspace plan the new user is a billed licence Risk: destructive
Input A plain password is 8 to 100 characters. With hashFunction set it is a hash, which can be longer.
Output

list

users.list List users in the account or one domain, with Google’s search query and paging Risk: read
Input Send customer or domain; my_customer names the caller’s own account. Output

makeAdmin

users.makeAdmin Grant or revoke super administrator on a user. The caller cannot revoke its own last admin right Risk: destructive
Input A caller cannot revoke its own last super admin right. Output: void

photos.delete

users.photos.delete Remove a user’s profile photo Risk: destructive
Input Output: void

photos.get

users.photos.get Read a user’s profile photo as base64 bytes Risk: read
Input Output

photos.update

users.photos.update Replace a user’s profile photo Risk: write
Input photoData is Google’s web-safe base64 of a JPEG or PNG: - and _ in place of + and /, and . (not =) for padding. Output

signOut

users.signOut Sign a user out of all web and device sessions, clearing their sign-in cookies Risk: destructive
Input Output: void

undelete

users.undelete Restore a deleted user by ID and optionally set the organizational unit it returns to Risk: write
Input Takes the immutable user ID. An email address answers 404. Output: void

update

users.update Update a user through the PUT that keeps the patch semantics Google documents for it: omitted fields are preserved, a field sent as null is cleared Risk: write
Input Absent fields keep their value; a field sent as null is cleared.
Output