docs/dyn/admin_directory_v1.domains.html - platform/external/python/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.domains.html">domains</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#delete">delete(customer, domainName)</a></code></p>
 <p class="firstline">Deletes a domain of the customer.</p>
 <p class="toc_element">
   <code><a href="#get">get(customer, domainName)</a></code></p>
 <p class="firstline">Retrieves a domain of the customer.</p>
 <p class="toc_element">
   <code><a href="#insert">insert(customer, body)</a></code></p>
 <p class="firstline">Inserts a domain of the customer.</p>
 <p class="toc_element">
   <code><a href="#list">list(customer)</a></code></p>
 <p class="firstline">Lists the domains of the customer.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="delete">delete(customer, domainName)</code>
   <pre>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)
 </pre>
 </div>

 <div class="method">
     <code class="details" id="get">get(customer, domainName)</code>
   <pre>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).
     }</pre>
 </div>

 <div class="method">
     <code class="details" id="insert">insert(customer, body)</code>
   <pre>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).
     }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(customer)</code>
   <pre>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.
   }</pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.domains.html">domains</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#delete">delete(customer, domainName)</a></code></p>
	<p class="firstline">Deletes a domain of the customer.</p>
	<p class="toc_element">
	<code><a href="#get">get(customer, domainName)</a></code></p>
	<p class="firstline">Retrieves a domain of the customer.</p>
	<p class="toc_element">
	<code><a href="#insert">insert(customer, body)</a></code></p>
	<p class="firstline">Inserts a domain of the customer.</p>
	<p class="toc_element">
	<code><a href="#list">list(customer)</a></code></p>
	<p class="firstline">Lists the domains of the customer.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="delete">delete(customer, domainName)</code>
	<pre>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)
	</pre>
	</div>

	<div class="method">
	<code class="details" id="get">get(customer, domainName)</code>
	<pre>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).
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="insert">insert(customer, body)</code>
	<pre>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).
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(customer)</code>
	<pre>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.
	}</pre>
	</div>

	</body></html>