/
admin_directory_v1.groups.html
377 lines (329 loc) 路 26 KB
/
admin_directory_v1.groups.html
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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
<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 SDK 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="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(groupKey, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a group.</p>
<p class="toc_element">
<code><a href="#get">get(groupKey, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a group's properties.</p>
<p class="toc_element">
<code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a group.</p>
<p class="toc_element">
<code><a href="#list">list(customer=None, domain=None, maxResults=None, orderBy=None, pageToken=None, query=None, sortOrder=None, userKey=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves 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=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a group's properties. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).</p>
<p class="toc_element">
<code><a href="#update">update(groupKey, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a group's properties.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(groupKey, x__xgafv=None)</code>
<pre>Deletes a group.
Args:
groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(groupKey, x__xgafv=None)</code>
<pre>Retrieves a group's properties.
Args:
groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
"adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # List of a group's alias email addresses.
"A String",
],
"description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
"email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
"etag": "A String", # ETag of the resource.
"id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
"kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
"name": "A String", # The group's display name.
"nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body=None, x__xgafv=None)</code>
<pre>Creates a group.
Args:
body: object, The request body.
The object takes the form of:
{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
"adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # List of a group's alias email addresses.
"A String",
],
"description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
"email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
"etag": "A String", # ETag of the resource.
"id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
"kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
"name": "A String", # The group's display name.
"nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
"adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # List of a group's alias email addresses.
"A String",
],
"description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
"email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
"etag": "A String", # ETag of the resource.
"id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
"kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
"name": "A String", # The group's display name.
"nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customer=None, domain=None, maxResults=None, orderBy=None, pageToken=None, query=None, sortOrder=None, userKey=None, x__xgafv=None)</code>
<pre>Retrieves all groups of a domain or of a user given a userKey (paginated).
Args:
customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
domain: string, The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the `customer` query parameter instead.
maxResults: integer, Maximum number of results to return. Max allowed value is 200.
orderBy: string, Column to use for sorting results
Allowed values
email - Email of the group.
pageToken: string, Token to specify next page in the list
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
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.
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 it's an ID, it should match with the ID of the user object.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # ETag of the resource.
"groups": [ # List of group objects.
{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
"adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # List of a group's alias email addresses.
"A String",
],
"description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
"email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
"etag": "A String", # ETag of the resource.
"id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
"kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
"name": "A String", # The group's display name.
"nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
"A String",
],
},
],
"kind": "admin#directory#groups", # Kind of resource this is.
"nextPageToken": "A String", # Token used to access next page of this result.
}</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=None, x__xgafv=None)</code>
<pre>Updates a group's properties. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).
Args:
groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
body: object, The request body.
The object takes the form of:
{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
"adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # List of a group's alias email addresses.
"A String",
],
"description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
"email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
"etag": "A String", # ETag of the resource.
"id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
"kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
"name": "A String", # The group's display name.
"nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
"adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # List of a group's alias email addresses.
"A String",
],
"description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
"email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
"etag": "A String", # ETag of the resource.
"id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
"kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
"name": "A String", # The group's display name.
"nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(groupKey, body=None, x__xgafv=None)</code>
<pre>Updates a group's properties.
Args:
groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
body: object, The request body.
The object takes the form of:
{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
"adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # List of a group's alias email addresses.
"A String",
],
"description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
"email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
"etag": "A String", # ETag of the resource.
"id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
"kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
"name": "A String", # The group's display name.
"nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
"adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # List of a group's alias email addresses.
"A String",
],
"description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
"directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
"email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
"etag": "A String", # ETag of the resource.
"id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
"kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
"name": "A String", # The group's display name.
"nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
"A String",
],
}</pre>
</div>
</body></html>