1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="admin_directory_v1.html">Admin SDK API</a> . <a href="admin_directory_v1.domains.html">domains</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(customer, domainName, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a domain of the customer.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(customer, domainName, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves a domain of the customer.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(customer, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Inserts a domain of the customer.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(customer, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the domains of the customer.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="delete">delete(customer, domainName, x__xgafv=None)</code> 100 <pre>Deletes a domain of the customer. 101 102Args: 103 customer: string, Immutable ID of the Google Workspace account. (required) 104 domainName: string, Name of domain to be deleted (required) 105 x__xgafv: string, V1 error format. 106 Allowed values 107 1 - v1 error format 108 2 - v2 error format 109</pre> 110</div> 111 112<div class="method"> 113 <code class="details" id="get">get(customer, domainName, x__xgafv=None)</code> 114 <pre>Retrieves a domain of the customer. 115 116Args: 117 customer: string, Immutable ID of the Google Workspace account. (required) 118 domainName: string, Name of domain to be retrieved (required) 119 x__xgafv: string, V1 error format. 120 Allowed values 121 1 - v1 error format 122 2 - v2 error format 123 124Returns: 125 An object of the form: 126 127 { 128 "creationTime": "A String", # Creation time of the domain. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format. (Read-only). 129 "domainAliases": [ # List of domain alias objects. (Read-only) 130 { 131 "creationTime": "A String", # The creation time of the domain alias. (Read-only). 132 "domainAliasName": "A String", # The domain alias name. 133 "etag": "A String", # ETag of the resource. 134 "kind": "admin#directory#domainAlias", # Kind of resource this is. 135 "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. 136 "verified": True or False, # Indicates the verification state of a domain alias. (Read-only) 137 }, 138 ], 139 "domainName": "A String", # The domain name of the customer. 140 "etag": "A String", # ETag of the resource. 141 "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only). 142 "kind": "admin#directory#domain", # Kind of resource this is. 143 "verified": True or False, # Indicates the verification state of a domain. (Read-only). 144}</pre> 145</div> 146 147<div class="method"> 148 <code class="details" id="insert">insert(customer, body=None, x__xgafv=None)</code> 149 <pre>Inserts a domain of the customer. 150 151Args: 152 customer: string, Immutable ID of the Google Workspace account. (required) 153 body: object, The request body. 154 The object takes the form of: 155 156{ 157 "creationTime": "A String", # Creation time of the domain. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format. (Read-only). 158 "domainAliases": [ # List of domain alias objects. (Read-only) 159 { 160 "creationTime": "A String", # The creation time of the domain alias. (Read-only). 161 "domainAliasName": "A String", # The domain alias name. 162 "etag": "A String", # ETag of the resource. 163 "kind": "admin#directory#domainAlias", # Kind of resource this is. 164 "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. 165 "verified": True or False, # Indicates the verification state of a domain alias. (Read-only) 166 }, 167 ], 168 "domainName": "A String", # The domain name of the customer. 169 "etag": "A String", # ETag of the resource. 170 "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only). 171 "kind": "admin#directory#domain", # Kind of resource this is. 172 "verified": True or False, # Indicates the verification state of a domain. (Read-only). 173} 174 175 x__xgafv: string, V1 error format. 176 Allowed values 177 1 - v1 error format 178 2 - v2 error format 179 180Returns: 181 An object of the form: 182 183 { 184 "creationTime": "A String", # Creation time of the domain. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format. (Read-only). 185 "domainAliases": [ # List of domain alias objects. (Read-only) 186 { 187 "creationTime": "A String", # The creation time of the domain alias. (Read-only). 188 "domainAliasName": "A String", # The domain alias name. 189 "etag": "A String", # ETag of the resource. 190 "kind": "admin#directory#domainAlias", # Kind of resource this is. 191 "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. 192 "verified": True or False, # Indicates the verification state of a domain alias. (Read-only) 193 }, 194 ], 195 "domainName": "A String", # The domain name of the customer. 196 "etag": "A String", # ETag of the resource. 197 "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only). 198 "kind": "admin#directory#domain", # Kind of resource this is. 199 "verified": True or False, # Indicates the verification state of a domain. (Read-only). 200}</pre> 201</div> 202 203<div class="method"> 204 <code class="details" id="list">list(customer, x__xgafv=None)</code> 205 <pre>Lists the domains of the customer. 206 207Args: 208 customer: string, Immutable ID of the Google Workspace account. (required) 209 x__xgafv: string, V1 error format. 210 Allowed values 211 1 - v1 error format 212 2 - v2 error format 213 214Returns: 215 An object of the form: 216 217 { 218 "domains": [ # List of domain objects. 219 { 220 "creationTime": "A String", # Creation time of the domain. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format. (Read-only). 221 "domainAliases": [ # List of domain alias objects. (Read-only) 222 { 223 "creationTime": "A String", # The creation time of the domain alias. (Read-only). 224 "domainAliasName": "A String", # The domain alias name. 225 "etag": "A String", # ETag of the resource. 226 "kind": "admin#directory#domainAlias", # Kind of resource this is. 227 "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. 228 "verified": True or False, # Indicates the verification state of a domain alias. (Read-only) 229 }, 230 ], 231 "domainName": "A String", # The domain name of the customer. 232 "etag": "A String", # ETag of the resource. 233 "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only). 234 "kind": "admin#directory#domain", # Kind of resource this is. 235 "verified": True or False, # Indicates the verification state of a domain. (Read-only). 236 }, 237 ], 238 "etag": "A String", # ETag of the resource. 239 "kind": "admin#directory#domains", # Kind of resource this is. 240}</pre> 241</div> 242 243</body></html>