Get
|
|||||
|
|
||||
Retrieves a domain of the customer
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage the provisioning of domains for your customers
- View domains related to your customers
Input
This building block consumes 2 input parameters
| Name | Format | Description |
|---|---|---|
customer Required |
STRING |
Immutable ID of the G Suite account |
domainName Required |
STRING |
Name of domain to be retrieved |
= Parameter name
= Format
|
customer STRING Required Immutable ID of the G Suite account |
|
domainName STRING Required Name of domain to be retrieved |
Output
This building block provides 13 output parameters
| Name | Format | Description |
|---|---|---|
domainAliases[] |
OBJECT |
|
domainAliases[].etag |
STRING |
ETag of the resource |
domainAliases[].kind |
STRING |
Kind of resource this is |
domainAliases[].parentDomainName |
STRING |
The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer |
domainAliases[].domainAliasName |
STRING |
The domain alias name |
domainAliases[].verified |
BOOLEAN |
Indicates the verification state of a domain alias. (Read-only) |
domainAliases[].creationTime |
INTEGER |
The creation time of the domain alias. (Read-only) |
domainName |
STRING |
The domain name of the customer |
isPrimary |
BOOLEAN |
Indicates if the domain is a primary domain (Read-only) |
kind |
STRING |
Kind of resource this is |
creationTime |
INTEGER |
Creation time of the domain. (Read-only) |
etag |
STRING |
ETag of the resource |
verified |
BOOLEAN |
Indicates the verification state of a domain. (Read-only) |
= Parameter name
= Format
|
domainAliases[] OBJECT |
|
domainAliases[].etag STRING ETag of the resource |
|
domainAliases[].kind STRING Kind of resource this is |
|
domainAliases[].parentDomainName STRING The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer |
|
domainAliases[].domainAliasName STRING The domain alias name |
|
domainAliases[].verified BOOLEAN Indicates the verification state of a domain alias. (Read-only) |
|
domainAliases[].creationTime INTEGER The creation time of the domain alias. (Read-only) |
|
domainName STRING The domain name of the customer |
|
isPrimary BOOLEAN Indicates if the domain is a primary domain (Read-only) |
|
kind STRING Kind of resource this is |
|
creationTime INTEGER Creation time of the domain. (Read-only) |
|
etag STRING ETag of the resource |
|
verified BOOLEAN Indicates the verification state of a domain. (Read-only) |