domains

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

Overview

Name	domains
Type	Resource
Id	googleadmin.directory.domains

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
creationTime	string (int64)	Creation time of the domain. Expressed in Unix time format. (Read-only).
domainAliases	array	A list of domain alias objects. (Read-only)
domainName	string	The domain name of the customer.
etag	string	ETag of the resource.
isPrimary	boolean	Indicates if the domain is a primary domain (Read-only).
kind	string	Kind of resource this is. (default: admin#directory#domain)
verified	boolean	Indicates the verification state of a domain. (Read-only).

list

Successful response

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	customer, domainName		Retrieves a domain of the customer.
list	select	customer		Lists the domains of the customer.
insert	insert	customer		Inserts a domain of the customer.
delete	delete	customer, domainName		Deletes a domain 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
domainName	string

SELECT examples

get

Retrieves a domain of the customer.

SELECT
creationTime,
domainAliases,
domainName,
etag,
isPrimary,
kind,
verified
FROM googleadmin.directory.domains
WHERE customer = '{{ customer }}' -- required
AND domainName = '{{ domainName }}' -- required;

list

Lists the domains of the customer.

SELECT
domains,
etag,
kind
FROM googleadmin.directory.domains
WHERE customer = '{{ customer }}' -- required;

INSERT examples

insert

Inserts a domain of the customer.

INSERT INTO googleadmin.directory.domains (
data__kind,
data__domainAliases,
data__verified,
data__etag,
data__creationTime,
data__isPrimary,
data__domainName,
customer
)
SELECT 
'{{ kind }}',
'{{ domainAliases }}',
{{ verified }},
'{{ etag }}',
'{{ creationTime }}',
{{ isPrimary }},
'{{ domainName }}',
'{{ customer }}'
RETURNING
creationTime,
domainAliases,
domainName,
etag,
isPrimary,
kind,
verified
;

Manifest

# Description fields are for documentation purposes
- name: domains
  props:
    - name: customer
      value: string
      description: Required parameter for the domains resource.
    - name: kind
      value: string
      description: >
        Kind of resource this is.
        
      default: admin#directory#domain
    - name: domainAliases
      value: array
      description: >
        A list of domain alias objects. (Read-only)
        
    - name: verified
      value: boolean
      description: >
        Indicates the verification state of a domain. (Read-only).
        
    - name: etag
      value: string
      description: >
        ETag of the resource.
        
    - name: creationTime
      value: string
      description: >
        Creation time of the domain. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format. (Read-only).
        
    - name: isPrimary
      value: boolean
      description: >
        Indicates if the domain is a primary domain (Read-only).
        
    - name: domainName
      value: string
      description: >
        The domain name of the customer.
        

DELETE examples

delete

Deletes a domain of the customer.

DELETE FROM googleadmin.directory.domains
WHERE customer = '{{ customer }}' --required
AND domainName = '{{ domainName }}' --required;