REST Resource: domains

Resource: Domain

A registered domain resource in the Postmaster API.

JSON representation
{
  "name": string,
  "createTime": string,
  "permission": enum (Permission)
}
Fields
name

string

The resource name of the Domain. Domain names have the form domains/{domain_name}, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).

createTime

string (Timestamp format)

Timestamp when the user registered this domain. Assigned by the server.

permission

enum (Permission)

User’s permission for this domain. Assigned by the server.

Permission

The possible permissions a user can have for a domain.

Enums
PERMISSION_UNSPECIFIED The default value and should never be used explicitly.
OWNER User has read access to the domain and can share access with others.
READER User has read access to the domain.
NONE User doesn't have permission to access information about the domain. User did not verify ownership of domain nor was access granted by other domain owners.

Methods

get

Gets a specific domain registered by the client.

list

Lists the domains that have been registered by the client.