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.domainAliases.html">domainAliases</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(customer, domainAliasName)</a></code></p> 79 <p class="firstline">Deletes a Domain Alias of the customer.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(customer, domainAliasName)</a></code></p> 82 <p class="firstline">Retrieves a domain alias 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 alias of the customer.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(customer, parentDomainName=None)</a></code></p> 88 <p class="firstline">Lists the domain aliases of the customer.</p> 89 <h3>Method Details</h3> 90 <div class="method"> 91 <code class="details" id="delete">delete(customer, domainAliasName)</code> 92 <pre>Deletes a Domain Alias of the customer. 93 94 Args: 95 customer: string, Immutable ID of the G Suite account. (required) 96 domainAliasName: string, Name of domain alias to be retrieved. (required) 97 </pre> 98 </div> 99 100 <div class="method"> 101 <code class="details" id="get">get(customer, domainAliasName)</code> 102 <pre>Retrieves a domain alias of the customer. 103 104 Args: 105 customer: string, Immutable ID of the G Suite account. (required) 106 domainAliasName: string, Name of domain alias to be retrieved. (required) 107 108 Returns: 109 An object of the form: 110 111 { # JSON template for Domain Alias object in Directory API. 112 "kind": "admin#directory#domainAlias", # Kind of resource this is. 113 "verified": True or False, # Indicates the verification state of a domain alias. (Read-only) 114 "creationTime": "A String", # The creation time of the domain alias. (Read-only). 115 "etag": "A String", # ETag of the resource. 116 "domainAliasName": "A String", # The domain alias name. 117 "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. 118 }</pre> 119 </div> 120 121 <div class="method"> 122 <code class="details" id="insert">insert(customer, body)</code> 123 <pre>Inserts a Domain alias of the customer. 124 125 Args: 126 customer: string, Immutable ID of the G Suite account. (required) 127 body: object, The request body. (required) 128 The object takes the form of: 129 130 { # JSON template for Domain Alias object in Directory API. 131 "kind": "admin#directory#domainAlias", # Kind of resource this is. 132 "verified": True or False, # Indicates the verification state of a domain alias. (Read-only) 133 "creationTime": "A String", # The creation time of the domain alias. (Read-only). 134 "etag": "A String", # ETag of the resource. 135 "domainAliasName": "A String", # The domain alias name. 136 "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. 137 } 138 139 140 Returns: 141 An object of the form: 142 143 { # JSON template for Domain Alias object in Directory API. 144 "kind": "admin#directory#domainAlias", # Kind of resource this is. 145 "verified": True or False, # Indicates the verification state of a domain alias. (Read-only) 146 "creationTime": "A String", # The creation time of the domain alias. (Read-only). 147 "etag": "A String", # ETag of the resource. 148 "domainAliasName": "A String", # The domain alias name. 149 "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. 150 }</pre> 151 </div> 152 153 <div class="method"> 154 <code class="details" id="list">list(customer, parentDomainName=None)</code> 155 <pre>Lists the domain aliases of the customer. 156 157 Args: 158 customer: string, Immutable ID of the G Suite account. (required) 159 parentDomainName: string, Name of the parent domain for which domain aliases are to be fetched. 160 161 Returns: 162 An object of the form: 163 164 { # JSON response template to list domain aliases in Directory API. 165 "domainAliases": [ # List of domain alias objects. 166 { # JSON template for Domain Alias object in Directory API. 167 "kind": "admin#directory#domainAlias", # Kind of resource this is. 168 "verified": True or False, # Indicates the verification state of a domain alias. (Read-only) 169 "creationTime": "A String", # The creation time of the domain alias. (Read-only). 170 "etag": "A String", # ETag of the resource. 171 "domainAliasName": "A String", # The domain alias name. 172 "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. 173 }, 174 ], 175 "kind": "admin#directory#domainAliases", # Kind of resource this is. 176 "etag": "A String", # ETag of the resource. 177 }</pre> 178 </div> 179 180 </body></html>
