1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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 Directory 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="#delete">delete(customer, domainName)</a></code></p> 79 <p class="firstline">Deletes a domain of the customer.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(customer, domainName)</a></code></p> 82 <p class="firstline">Retrieves a domain of the customer.</p> 83 <p class="toc_element"> 84 <code><a href="#insert">insert(customer, body)</a></code></p> 85 <p class="firstline">Inserts a domain of the customer.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(customer)</a></code></p> 88 <p class="firstline">Lists the domains of the customer.</p> 89 <h3>Method Details</h3> 90 <div class="method"> 91 <code class="details" id="delete">delete(customer, domainName)</code> 92 <pre>Deletes a domain of the customer. 93 94 Args: 95 customer: string, Immutable ID of the G Suite account. (required) 96 domainName: string, Name of domain to be deleted (required) 97 </pre> 98 </div> 99 100 <div class="method"> 101 <code class="details" id="get">get(customer, domainName)</code> 102 <pre>Retrieves a domain of the customer. 103 104 Args: 105 customer: string, Immutable ID of the G Suite account. (required) 106 domainName: string, Name of domain to be retrieved (required) 107 108 Returns: 109 An object of the form: 110 111 { # JSON template for Domain object in Directory API. 112 "kind": "admin#directory#domain", # Kind of resource this is. 113 "verified": True or False, # Indicates the verification state of a domain. (Read-only). 114 "domainName": "A String", # The domain name of the customer. 115 "creationTime": "A String", # Creation time of the domain. (Read-only). 116 "etag": "A String", # ETag of the resource. 117 "domainAliases": [ # List of domain alias objects. (Read-only) 118 { # JSON template for Domain Alias object in Directory API. 119 "kind": "admin#directory#domainAlias", # Kind of resource this is. 120 "verified": True or False, # Indicates the verification state of a domain alias. (Read-only) 121 "creationTime": "A String", # The creation time of the domain alias. (Read-only). 122 "etag": "A String", # ETag of the resource. 123 "domainAliasName": "A String", # The domain alias name. 124 "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. 125 }, 126 ], 127 "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only). 128 }</pre> 129 </div> 130 131 <div class="method"> 132 <code class="details" id="insert">insert(customer, body)</code> 133 <pre>Inserts a domain of the customer. 134 135 Args: 136 customer: string, Immutable ID of the G Suite account. (required) 137 body: object, The request body. (required) 138 The object takes the form of: 139 140 { # JSON template for Domain object in Directory API. 141 "kind": "admin#directory#domain", # Kind of resource this is. 142 "verified": True or False, # Indicates the verification state of a domain. (Read-only). 143 "domainName": "A String", # The domain name of the customer. 144 "creationTime": "A String", # Creation time of the domain. (Read-only). 145 "etag": "A String", # ETag of the resource. 146 "domainAliases": [ # List of domain alias objects. (Read-only) 147 { # JSON template for Domain Alias object in Directory API. 148 "kind": "admin#directory#domainAlias", # Kind of resource this is. 149 "verified": True or False, # Indicates the verification state of a domain alias. (Read-only) 150 "creationTime": "A String", # The creation time of the domain alias. (Read-only). 151 "etag": "A String", # ETag of the resource. 152 "domainAliasName": "A String", # The domain alias name. 153 "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. 154 }, 155 ], 156 "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only). 157 } 158 159 160 Returns: 161 An object of the form: 162 163 { # JSON template for Domain object in Directory API. 164 "kind": "admin#directory#domain", # Kind of resource this is. 165 "verified": True or False, # Indicates the verification state of a domain. (Read-only). 166 "domainName": "A String", # The domain name of the customer. 167 "creationTime": "A String", # Creation time of the domain. (Read-only). 168 "etag": "A String", # ETag of the resource. 169 "domainAliases": [ # List of domain alias objects. (Read-only) 170 { # JSON template for Domain Alias object in Directory API. 171 "kind": "admin#directory#domainAlias", # Kind of resource this is. 172 "verified": True or False, # Indicates the verification state of a domain alias. (Read-only) 173 "creationTime": "A String", # The creation time of the domain alias. (Read-only). 174 "etag": "A String", # ETag of the resource. 175 "domainAliasName": "A String", # The domain alias name. 176 "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. 177 }, 178 ], 179 "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only). 180 }</pre> 181 </div> 182 183 <div class="method"> 184 <code class="details" id="list">list(customer)</code> 185 <pre>Lists the domains of the customer. 186 187 Args: 188 customer: string, Immutable ID of the G Suite account. (required) 189 190 Returns: 191 An object of the form: 192 193 { # JSON response template to list Domains in Directory API. 194 "domains": [ # List of domain objects. 195 { # JSON template for Domain object in Directory API. 196 "kind": "admin#directory#domain", # Kind of resource this is. 197 "verified": True or False, # Indicates the verification state of a domain. (Read-only). 198 "domainName": "A String", # The domain name of the customer. 199 "creationTime": "A String", # Creation time of the domain. (Read-only). 200 "etag": "A String", # ETag of the resource. 201 "domainAliases": [ # List of domain alias objects. (Read-only) 202 { # JSON template for Domain Alias object in Directory API. 203 "kind": "admin#directory#domainAlias", # Kind of resource this is. 204 "verified": True or False, # Indicates the verification state of a domain alias. (Read-only) 205 "creationTime": "A String", # The creation time of the domain alias. (Read-only). 206 "etag": "A String", # ETag of the resource. 207 "domainAliasName": "A String", # The domain alias name. 208 "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. 209 }, 210 ], 211 "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only). 212 }, 213 ], 214 "kind": "admin#directory#domains", # Kind of resource this is. 215 "etag": "A String", # ETag of the resource. 216 }</pre> 217 </div> 218 219 </body></html>
