domain_aliases

Creates, updates, deletes, gets or lists a domain_aliases resource.

Overview

Name	domain_aliases
Type	Resource
Id	googleadmin.directory.domain_aliases

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
creationTime	string (int64)	The creation time of the domain alias. (Read-only).
domainAliasName	string	The domain alias name.
etag	string	ETag of the resource.
kind	string	Kind of resource this is. (default: admin#directory#domainAlias)
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.
verified	boolean	Indicates the verification state of a domain alias. (Read-only)

list

Successful response

Name	Datatype	Description
domainAliases	array	A list of domain alias objects.
etag	string	ETag of the resource.
kind	string	Kind of resource this is. (default: admin#directory#domainAliases)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	customer, domainAliasName		Retrieves a domain alias of the customer.
list	select	customer, parentDomainName		Lists the domain aliases of the customer.
insert	insert	customer		Inserts a domain alias of the customer.
delete	delete	customer, domainAliasName		Deletes a domain Alias of the customer.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
customer	string
domainAliasName	string
parentDomainName	string

SELECT examples

get

Retrieves a domain alias of the customer.

SELECT
creationTime,
domainAliasName,
etag,
kind,
parentDomainName,
verified
FROM googleadmin.directory.domain_aliases
WHERE customer = '{{ customer }}' -- required
AND domainAliasName = '{{ domainAliasName }}' -- required;

list

Lists the domain aliases of the customer.

SELECT
domainAliases,
etag,
kind
FROM googleadmin.directory.domain_aliases
WHERE customer = '{{ customer }}' -- required
AND parentDomainName = '{{ parentDomainName }}' -- required;

INSERT examples

insert

Inserts a domain alias of the customer.

INSERT INTO googleadmin.directory.domain_aliases (
data__kind,
data__parentDomainName,
data__verified,
data__creationTime,
data__etag,
data__domainAliasName,
customer
)
SELECT 
'{{ kind }}',
'{{ parentDomainName }}',
{{ verified }},
'{{ creationTime }}',
'{{ etag }}',
'{{ domainAliasName }}',
'{{ customer }}'
RETURNING
creationTime,
domainAliasName,
etag,
kind,
parentDomainName,
verified
;

Manifest

# Description fields are for documentation purposes
- name: domain_aliases
  props:
    - name: customer
      value: string
      description: Required parameter for the domain_aliases resource.
    - name: kind
      value: string
      description: >
        Kind of resource this is.
        
      default: admin#directory#domainAlias
    - name: parentDomainName
      value: string
      description: >
        The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
        
    - name: verified
      value: boolean
      description: >
        Indicates the verification state of a domain alias. (Read-only)
        
    - name: creationTime
      value: string
      description: >
        The creation time of the domain alias. (Read-only).
        
    - name: etag
      value: string
      description: >
        ETag of the resource.
        
    - name: domainAliasName
      value: string
      description: >
        The domain alias name.
        

DELETE examples

delete

Deletes a domain Alias of the customer.

DELETE FROM googleadmin.directory.domain_aliases
WHERE customer = '{{ customer }}' --required
AND domainAliasName = '{{ domainAliasName }}' --required;