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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
|
<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.groups.html">groups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="admin_directory_v1.groups.aliases.html">aliases()</a></code>
</p>
<p class="firstline">Returns the aliases Resource.</p>
<p class="toc_element">
<code><a href="#delete">delete(groupKey)</a></code></p>
<p class="firstline">Delete Group</p>
<p class="toc_element">
<code><a href="#get">get(groupKey)</a></code></p>
<p class="firstline">Retrieve Group</p>
<p class="toc_element">
<code><a href="#insert">insert(body)</a></code></p>
<p class="firstline">Create Group</p>
<p class="toc_element">
<code><a href="#list">list(customer=None, orderBy=None, domain=None, pageToken=None, maxResults=None, sortOrder=None, query=None, userKey=None)</a></code></p>
<p class="firstline">Retrieve all groups of a domain or of a user given a userKey (paginated)</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(groupKey, body)</a></code></p>
<p class="firstline">Update Group. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(groupKey, body)</a></code></p>
<p class="firstline">Update Group</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(groupKey)</code>
<pre>Delete Group
Args:
groupKey: string, Email or immutable ID of the group (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(groupKey)</code>
<pre>Retrieve Group
Args:
groupKey: string, Email or immutable ID of the group (required)
Returns:
An object of the form:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body)</code>
<pre>Create Group
Args:
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}
Returns:
An object of the form:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customer=None, orderBy=None, domain=None, pageToken=None, maxResults=None, sortOrder=None, query=None, userKey=None)</code>
<pre>Retrieve all groups of a domain or of a user given a userKey (paginated)
Args:
customer: string, Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.
orderBy: string, Column to use for sorting results
Allowed values
email - Email of the group.
domain: string, Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.
pageToken: string, Token to specify next page in the list
maxResults: integer, Maximum number of results to return. Default is 200
sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-groups
userKey: string, Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object
Returns:
An object of the form:
{ # JSON response template for List Groups operation in Directory API.
"nextPageToken": "A String", # Token used to access next page of this result.
"kind": "admin#directory#groups", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"groups": [ # List of group objects.
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(groupKey, body)</code>
<pre>Update Group. This method supports patch semantics.
Args:
groupKey: string, Email or immutable ID of the group. If ID, it should match with id of group object (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}
Returns:
An object of the form:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(groupKey, body)</code>
<pre>Update Group
Args:
groupKey: string, Email or immutable ID of the group. If ID, it should match with id of group object (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}
Returns:
An object of the form:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}</pre>
</div>
</body></html>
|
