REST Resource: domains

Resource: Domain

Information about a domain registered by the user.

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

string

Identifier. The resource name of the domain. Format: domains/{domain_name}, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).

permission

enum (Permission)

Output only. User's permission of this domain.

verificationState

enum (VerificationState)

Output only. Information about a user's verification history and properties for the domain.

createTime

string (Timestamp format)

Output only. Immutable. The timestamp at which the domain was added to the user's account.

lastVerifyTime

string (Timestamp format)

The timestamp at which the domain was last verified by the user.

Permission

The user's permission of a domain.

Enums
PERMISSION_UNSPECIFIED Unspecified permission.
READER User has read access to the domain.
OWNER User has owner access to the domain.
NONE User has no access to the domain.

VerificationState

The user's verification status of a domain.

Enums
VERIFICATION_STATE_UNSPECIFIED Unspecified.
UNVERIFIED The domain is unverified.
VERIFIED The domain is verified.

Methods

get

Retrieves detailed information about a domain registered by you.

getComplianceStatus

Retrieves the compliance status for a given domain.

list

Retrieves a list of all domains registered by you, along with their corresponding metadata.