Admin Directory API . domainAliases

Instance Methods

delete(customer, domainAliasName)

Deletes a Domain Alias of the customer.

get(customer, domainAliasName)

Retrieves a domain alias of the customer.

insert(customer, body=None)

Inserts a Domain alias of the customer.

list(customer, parentDomainName=None)

Lists the domain aliases of the customer.

Method Details

delete(customer, domainAliasName)
Deletes a Domain Alias of the customer.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  domainAliasName: string, Name of domain alias to be retrieved. (required)
get(customer, domainAliasName)
Retrieves a domain alias of the customer.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  domainAliasName: string, Name of domain alias to be retrieved. (required)

Returns:
  An object of the form:

    { # JSON template for Domain Alias object in Directory API.
    "creationTime": "A String", # The creation time of the domain alias. (Read-only).
    "domainAliasName": "A String", # The domain alias name.
    "etag": "A String", # ETag of the resource.
    "kind": "admin#directory#domainAlias", # Kind of resource this is.
    "parentDomainName": "A 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": True or False, # Indicates the verification state of a domain alias. (Read-only)
  }
insert(customer, body=None)
Inserts a Domain alias of the customer.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  body: object, The request body.
    The object takes the form of:

{ # JSON template for Domain Alias object in Directory API.
  "creationTime": "A String", # The creation time of the domain alias. (Read-only).
  "domainAliasName": "A String", # The domain alias name.
  "etag": "A String", # ETag of the resource.
  "kind": "admin#directory#domainAlias", # Kind of resource this is.
  "parentDomainName": "A 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": True or False, # Indicates the verification state of a domain alias. (Read-only)
}


Returns:
  An object of the form:

    { # JSON template for Domain Alias object in Directory API.
    "creationTime": "A String", # The creation time of the domain alias. (Read-only).
    "domainAliasName": "A String", # The domain alias name.
    "etag": "A String", # ETag of the resource.
    "kind": "admin#directory#domainAlias", # Kind of resource this is.
    "parentDomainName": "A 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": True or False, # Indicates the verification state of a domain alias. (Read-only)
  }
list(customer, parentDomainName=None)
Lists the domain aliases of the customer.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  parentDomainName: string, Name of the parent domain for which domain aliases are to be fetched.

Returns:
  An object of the form:

    { # JSON response template to list domain aliases in Directory API.
    "domainAliases": [ # List of domain alias objects.
      { # JSON template for Domain Alias object in Directory API.
        "creationTime": "A String", # The creation time of the domain alias. (Read-only).
        "domainAliasName": "A String", # The domain alias name.
        "etag": "A String", # ETag of the resource.
        "kind": "admin#directory#domainAlias", # Kind of resource this is.
        "parentDomainName": "A 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": True or False, # Indicates the verification state of a domain alias. (Read-only)
      },
    ],
    "etag": "A String", # ETag of the resource.
    "kind": "admin#directory#domainAliases", # Kind of resource this is.
  }