REST Resource: domains
Stay organized with collections
Save and categorize content based on your preferences.
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 |
|
|
Gets a specific domain registered by the client. |
|
|
Lists the domains that have been registered by the client. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-24 UTC.
[null,null,["Last updated 2025-03-24 UTC."],[],[],null,["# REST Resource: domains\n\n- [Resource: Domain](#Domain)\n - [JSON representation](#Domain.SCHEMA_REPRESENTATION)\n- [Permission](#Permission)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Domain\n----------------\n\nA registered domain resource in the Postmaster API.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"createTime\": string, \"permission\": enum (/workspace/gmail/postmaster/reference/rest/v1/domains#Permission) } ``` |\n\n| Fields ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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). |\n| `createTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Timestamp when the user registered this domain. Assigned by the server. |\n| `permission` | `enum (`[Permission](/workspace/gmail/postmaster/reference/rest/v1/domains#Permission)`)` User's permission for this domain. Assigned by the server. |\n\nPermission\n----------\n\nThe possible permissions a user can have for a domain.\n\n| Enums ||\n|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `PERMISSION_UNSPECIFIED` | The default value and should never be used explicitly. |\n| `OWNER` | User has read access to the domain and can share access with others. |\n| `READER` | User has read access to the domain. |\n| `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. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------|------------------------------------------------------------|\n| ### [get](/workspace/gmail/postmaster/reference/rest/v1/domains/get) | Gets a specific domain registered by the client. |\n| ### [list](/workspace/gmail/postmaster/reference/rest/v1/domains/list) | Lists the domains that have been registered by the client. |"]]
