Admin SDK API . domainAliases

close()

Close httplib2 connections.

delete(customer, domainAliasName, x__xgafv=None)

Deletes a domain Alias of the customer.

Args:
  customer: string, Immutable ID of the Google Workspace account. (required)
  domainAliasName: string, Name of domain alias to be retrieved. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

get(customer, domainAliasName, x__xgafv=None)

Retrieves a domain alias of the customer.

Args:
  customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
  domainAliasName: string, Name of domain alias to be retrieved. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "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, x__xgafv=None)

Inserts a domain alias of the customer.

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

{
  "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)
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "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, x__xgafv=None)

Lists the domain aliases of the customer.

Args:
  customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
  parentDomainName: string, Name of the parent domain for which domain aliases are to be fetched.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "domainAliases": [ # A list of domain alias objects.
    {
      "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.
}