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
|
<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.members.html">members</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(groupKey, memberKey)</a></code></p>
<p class="firstline">Remove membership.</p>
<p class="toc_element">
<code><a href="#get">get(groupKey, memberKey)</a></code></p>
<p class="firstline">Retrieve Group Member</p>
<p class="toc_element">
<code><a href="#hasMember">hasMember(groupKey, memberKey)</a></code></p>
<p class="firstline">Checks whether the given user is a member of the group. Membership can be direct or nested.</p>
<p class="toc_element">
<code><a href="#insert">insert(groupKey, body)</a></code></p>
<p class="firstline">Add user to the specified group.</p>
<p class="toc_element">
<code><a href="#list">list(groupKey, pageToken=None, maxResults=None, roles=None, includeDerivedMembership=None)</a></code></p>
<p class="firstline">Retrieve all members in a group (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, memberKey, body)</a></code></p>
<p class="firstline">Update membership of a user in the specified group. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(groupKey, memberKey, body)</a></code></p>
<p class="firstline">Update membership of a user in the specified group.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(groupKey, memberKey)</code>
<pre>Remove membership.
Args:
groupKey: string, Email or immutable ID of the group (required)
memberKey: string, Email or immutable ID of the member (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(groupKey, memberKey)</code>
<pre>Retrieve Group Member
Args:
groupKey: string, Email or immutable ID of the group (required)
memberKey: string, Email or immutable ID of the member (required)
Returns:
An object of the form:
{ # JSON template for Member resource in Directory API.
"status": "A String", # Status of member (Immutable)
"kind": "admin#directory#member", # Kind of resource this is.
"delivery_settings": "A String", # Delivery settings of member
"id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
"etag": "A String", # ETag of the resource.
"role": "A String", # Role of member
"type": "A String", # Type of member (Immutable)
"email": "A String", # Email of member (Read-only)
}</pre>
</div>
<div class="method">
<code class="details" id="hasMember">hasMember(groupKey, memberKey)</code>
<pre>Checks whether the given user is a member of the group. Membership can be direct or nested.
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)
memberKey: string, Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID. (required)
Returns:
An object of the form:
{ # JSON template for Has Member response in Directory API.
"isMember": True or False, # Identifies whether the given user is a member of the group. Membership can be direct or nested.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(groupKey, body)</code>
<pre>Add user to the specified group.
Args:
groupKey: string, Email or immutable ID of the group (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Member resource in Directory API.
"status": "A String", # Status of member (Immutable)
"kind": "admin#directory#member", # Kind of resource this is.
"delivery_settings": "A String", # Delivery settings of member
"id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
"etag": "A String", # ETag of the resource.
"role": "A String", # Role of member
"type": "A String", # Type of member (Immutable)
"email": "A String", # Email of member (Read-only)
}
Returns:
An object of the form:
{ # JSON template for Member resource in Directory API.
"status": "A String", # Status of member (Immutable)
"kind": "admin#directory#member", # Kind of resource this is.
"delivery_settings": "A String", # Delivery settings of member
"id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
"etag": "A String", # ETag of the resource.
"role": "A String", # Role of member
"type": "A String", # Type of member (Immutable)
"email": "A String", # Email of member (Read-only)
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(groupKey, pageToken=None, maxResults=None, roles=None, includeDerivedMembership=None)</code>
<pre>Retrieve all members in a group (paginated)
Args:
groupKey: string, Email or immutable ID of the group (required)
pageToken: string, Token to specify next page in the list
maxResults: integer, Maximum number of results to return. Default is 200
roles: string, Comma separated role values to filter list results on.
includeDerivedMembership: boolean, Whether to list indirect memberships. Default: false.
Returns:
An object of the form:
{ # JSON response template for List Members operation in Directory API.
"nextPageToken": "A String", # Token used to access next page of this result.
"kind": "admin#directory#members", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"members": [ # List of member objects.
{ # JSON template for Member resource in Directory API.
"status": "A String", # Status of member (Immutable)
"kind": "admin#directory#member", # Kind of resource this is.
"delivery_settings": "A String", # Delivery settings of member
"id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
"etag": "A String", # ETag of the resource.
"role": "A String", # Role of member
"type": "A String", # Type of member (Immutable)
"email": "A String", # Email of member (Read-only)
},
],
}</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, memberKey, body)</code>
<pre>Update membership of a user in the specified 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)
memberKey: string, Email or immutable ID of the user. If ID, it should match with id of member object (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Member resource in Directory API.
"status": "A String", # Status of member (Immutable)
"kind": "admin#directory#member", # Kind of resource this is.
"delivery_settings": "A String", # Delivery settings of member
"id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
"etag": "A String", # ETag of the resource.
"role": "A String", # Role of member
"type": "A String", # Type of member (Immutable)
"email": "A String", # Email of member (Read-only)
}
Returns:
An object of the form:
{ # JSON template for Member resource in Directory API.
"status": "A String", # Status of member (Immutable)
"kind": "admin#directory#member", # Kind of resource this is.
"delivery_settings": "A String", # Delivery settings of member
"id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
"etag": "A String", # ETag of the resource.
"role": "A String", # Role of member
"type": "A String", # Type of member (Immutable)
"email": "A String", # Email of member (Read-only)
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(groupKey, memberKey, body)</code>
<pre>Update membership of a user in the specified group.
Args:
groupKey: string, Email or immutable ID of the group. If ID, it should match with id of group object (required)
memberKey: string, Email or immutable ID of the user. If ID, it should match with id of member object (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Member resource in Directory API.
"status": "A String", # Status of member (Immutable)
"kind": "admin#directory#member", # Kind of resource this is.
"delivery_settings": "A String", # Delivery settings of member
"id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
"etag": "A String", # ETag of the resource.
"role": "A String", # Role of member
"type": "A String", # Type of member (Immutable)
"email": "A String", # Email of member (Read-only)
}
Returns:
An object of the form:
{ # JSON template for Member resource in Directory API.
"status": "A String", # Status of member (Immutable)
"kind": "admin#directory#member", # Kind of resource this is.
"delivery_settings": "A String", # Delivery settings of member
"id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
"etag": "A String", # ETag of the resource.
"role": "A String", # Role of member
"type": "A String", # Type of member (Immutable)
"email": "A String", # Email of member (Read-only)
}</pre>
</div>
</body></html>
|
