Debian Codegraph @

docs/dyn/admin_directory_v1.members.html

raw
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 SDK API</a> . <a href="admin_directory_v1.members.html">members</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(groupKey, memberKey, x__xgafv=None)</a></code></p>
82 <p class="firstline">Removes a member from a group.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(groupKey, memberKey, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves a group member's properties.</p>
86 <p class="toc_element">
87 <code><a href="#hasMember">hasMember(groupKey, memberKey, x__xgafv=None)</a></code></p>
88 <p class="firstline">Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested, the `memberKey` and `groupKey` must be entities in the same domain or an `Invalid input` error is returned. To check for nested memberships that include entities outside of the group's domain, use the [`checkTransitiveMembership()`](https://cloud.google.com/identity/docs/reference/rest/v1/groups.memberships/checkTransitiveMembership) method in the Cloud Identity Groups API.</p>
89 <p class="toc_element">
90 <code><a href="#insert">insert(groupKey, body=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Adds a user to the specified group.</p>
92 <p class="toc_element">
93 <code><a href="#list">list(groupKey, includeDerivedMembership=None, maxResults=None, pageToken=None, roles=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).</p>
95 <p class="toc_element">
96 <code><a href="#list_next">list_next()</a></code></p>
97 <p class="firstline">Retrieves the next page of results.</p>
98 <p class="toc_element">
99 <code><a href="#patch">patch(groupKey, memberKey, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Updates the membership properties of a user in the specified group. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).</p>
101 <p class="toc_element">
102 <code><a href="#update">update(groupKey, memberKey, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Updates the membership of a user in the specified group.</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108 </div>
109
110 <div class="method">
111 <code class="details" id="delete">delete(groupKey, memberKey, x__xgafv=None)</code>
112 <pre>Removes a member from a group.
113
114 Args:
115 groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
116 memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member&#x27;s (group or user) primary email address, alias, or unique ID. (required)
117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
121 </pre>
122 </div>
123
124 <div class="method">
125 <code class="details" id="get">get(groupKey, memberKey, x__xgafv=None)</code>
126 <pre>Retrieves a group member&#x27;s properties.
127
128 Args:
129 groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
130 memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member&#x27;s (group or user) primary email address, alias, or unique ID. (required)
131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
135
136 Returns:
137 An object of the form:
138
139 { # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
140 &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
141 &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
142 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
143 &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
144 &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
145 &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
146 &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
147 &quot;type&quot;: &quot;A String&quot;, # The type of group member.
148 }</pre>
149 </div>
150
151 <div class="method">
152 <code class="details" id="hasMember">hasMember(groupKey, memberKey, x__xgafv=None)</code>
153 <pre>Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested, the `memberKey` and `groupKey` must be entities in the same domain or an `Invalid input` error is returned. To check for nested memberships that include entities outside of the group&#x27;s domain, use the [`checkTransitiveMembership()`](https://cloud.google.com/identity/docs/reference/rest/v1/groups.memberships/checkTransitiveMembership) method in the Cloud Identity Groups API.
154
155 Args:
156 groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
157 memberKey: string, Identifies the user member in the API request. The value can be the user&#x27;s primary email address, alias, or unique ID. (required)
158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
162
163 Returns:
164 An object of the form:
165
166 { # JSON template for Has Member response in Directory API.
167 &quot;isMember&quot;: True or False, # Output only. Identifies whether the given user is a member of the group. Membership can be direct or nested.
168 }</pre>
169 </div>
170
171 <div class="method">
172 <code class="details" id="insert">insert(groupKey, body=None, x__xgafv=None)</code>
173 <pre>Adds a user to the specified group.
174
175 Args:
176 groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
177 body: object, The request body.
178 The object takes the form of:
179
180 { # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
181 &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
182 &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
183 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
184 &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
185 &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
186 &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
187 &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
188 &quot;type&quot;: &quot;A String&quot;, # The type of group member.
189 }
190
191 x__xgafv: string, V1 error format.
192 Allowed values
193 1 - v1 error format
194 2 - v2 error format
195
196 Returns:
197 An object of the form:
198
199 { # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
200 &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
201 &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
202 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
203 &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
204 &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
205 &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
206 &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
207 &quot;type&quot;: &quot;A String&quot;, # The type of group member.
208 }</pre>
209 </div>
210
211 <div class="method">
212 <code class="details" id="list">list(groupKey, includeDerivedMembership=None, maxResults=None, pageToken=None, roles=None, x__xgafv=None)</code>
213 <pre>Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).
214
215 Args:
216 groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
217 includeDerivedMembership: boolean, Whether to list indirect memberships. Default: false.
218 maxResults: integer, Maximum number of results to return. Max allowed value is 200.
219 pageToken: string, Token to specify next page in the list.
220 roles: string, The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`.
221 x__xgafv: string, V1 error format.
222 Allowed values
223 1 - v1 error format
224 2 - v2 error format
225
226 Returns:
227 An object of the form:
228
229 {
230 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
231 &quot;kind&quot;: &quot;admin#directory#members&quot;, # Kind of resource this is.
232 &quot;members&quot;: [ # A list of member objects.
233 { # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
234 &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
235 &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
236 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
237 &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
238 &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
239 &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
240 &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
241 &quot;type&quot;: &quot;A String&quot;, # The type of group member.
242 },
243 ],
244 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token used to access next page of this result.
245 }</pre>
246 </div>
247
248 <div class="method">
249 <code class="details" id="list_next">list_next()</code>
250 <pre>Retrieves the next page of results.
251
252 Args:
253 previous_request: The request for the previous page. (required)
254 previous_response: The response from the request for the previous page. (required)
255
256 Returns:
257 A request object that you can call &#x27;execute()&#x27; on to request the next
258 page. Returns None if there are no more items in the collection.
259 </pre>
260 </div>
261
262 <div class="method">
263 <code class="details" id="patch">patch(groupKey, memberKey, body=None, x__xgafv=None)</code>
264 <pre>Updates the membership properties of a user in the specified group. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
265
266 Args:
267 groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
268 memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member&#x27;s (group or user) primary email address, alias, or unique ID. (required)
269 body: object, The request body.
270 The object takes the form of:
271
272 { # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
273 &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
274 &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
275 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
276 &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
277 &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
278 &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
279 &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
280 &quot;type&quot;: &quot;A String&quot;, # The type of group member.
281 }
282
283 x__xgafv: string, V1 error format.
284 Allowed values
285 1 - v1 error format
286 2 - v2 error format
287
288 Returns:
289 An object of the form:
290
291 { # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
292 &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
293 &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
294 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
295 &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
296 &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
297 &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
298 &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
299 &quot;type&quot;: &quot;A String&quot;, # The type of group member.
300 }</pre>
301 </div>
302
303 <div class="method">
304 <code class="details" id="update">update(groupKey, memberKey, body=None, x__xgafv=None)</code>
305 <pre>Updates the membership of a user in the specified group.
306
307 Args:
308 groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
309 memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member&#x27;s (group or user) primary email address, alias, or unique ID. (required)
310 body: object, The request body.
311 The object takes the form of:
312
313 { # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
314 &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
315 &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
316 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
317 &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
318 &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
319 &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
320 &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
321 &quot;type&quot;: &quot;A String&quot;, # The type of group member.
322 }
323
324 x__xgafv: string, V1 error format.
325 Allowed values
326 1 - v1 error format
327 2 - v2 error format
328
329 Returns:
330 An object of the form:
331
332 { # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
333 &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
334 &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
335 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
336 &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
337 &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
338 &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
339 &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
340 &quot;type&quot;: &quot;A String&quot;, # The type of group member.
341 }</pre>
342 </div>
343
344 </body></html>