1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
<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>
|
