Admin Directory API . domains

Instance Methods

delete(customer=*, domainName=*)

Deletes a domain of the customer.

get(customer=*, domainName=*)

Retrieves a domain of the customer.

insert(customer=*, body=*)

Inserts a domain of the customer.

list(customer=*)

Lists the domains of the customer.

Method Details

delete(customer=*, domainName=*)
Deletes a domain of the customer.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  domainName: string, Name of domain to be deleted (required)
get(customer=*, domainName=*)
Retrieves a domain of the customer.

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

Returns:
  An object of the form:

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

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

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


Returns:
  An object of the form:

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

Args:
  customer: string, Immutable ID of the G Suite account. (required)

Returns:
  An object of the form:

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