Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / cloudidentity_v1.groups.memberships.html
blob: 5ca388c4523e74c99d0c33bbb4d17f4fde1c8122 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="cloudidentity_v1.html">Cloud Identity API</a> . <a href="cloudidentity_v1.groups.html">groups</a> . <a href="cloudidentity_v1.groups.memberships.html">memberships</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a Membership.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a Membership.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves a Membership.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, view=None)</a></code></p>
88<p class="firstline">List Memberships within a Group.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#lookup">lookup(parent, memberKey_namespace=None, memberKey_id=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Looks up [resource</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
98 <pre>Creates a Membership.
99
100Args:
101 parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the
102Group to create Membership within. Format: `groups/{group_id}`, where
103`group_id` is the unique ID assigned to the Group. (required)
104 body: object, The request body. (required)
105 The object takes the form of:
106
107{ # Resource representing a Membership within a Group
108 "updateTime": "A String", # Last updated timestamp of the Membership. Output only.
109 "preferredMemberKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # EntityKey of the entity to be added as the member. Must be set while
110 # creating a Membership, read-only afterwards.
111 #
112 # Currently allowed entity types: `Users`, `Groups`.
113 # isolation for IDs. A single ID can be reused across namespaces but the
114 # combination of a namespace and an ID must be unique.
115 "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique
116 # within its namespace.
117 #
118 # Namespaces are currently only created as part of IdentitySource creation
119 # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
120 # created corresponding to every Identity Source `identity_source_id`.
121 "id": "A String", # The ID of the entity within the given namespace. The ID must be unique
122 # within its namespace.
123 },
124 "createTime": "A String", # Creation timestamp of the Membership. Output only.
125 "roles": [ # Roles for a member within the Group.
126 #
127 # Currently supported MembershipRoles: `"MEMBER"`.
128 { # Resource representing a role within a Membership.
129 "name": "A String", # MembershipRole in string format.
130 #
131 # Currently supported MembershipRoles: `"MEMBER"`.
132 },
133 ],
134 "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the
135 # Membership in the format: `groups/{group_id}/memberships/{member_id}`,
136 # where group_id is the unique ID assigned to the Group to which Membership
137 # belongs to, and member_id is the unique ID assigned to the member
138 #
139 # Must be left blank while creating a Membership.
140 }
141
142 x__xgafv: string, V1 error format.
143 Allowed values
144 1 - v1 error format
145 2 - v2 error format
146
147Returns:
148 An object of the form:
149
150 { # This resource represents a long-running operation that is the result of a
151 # network API call.
152 "metadata": { # Service-specific metadata associated with the operation. It typically
153 # contains progress information and common metadata such as create time.
154 # Some services might not provide such metadata. Any method that returns a
155 # long-running operation should document the metadata type, if any.
156 "a_key": "", # Properties of the object. Contains field @type with type URL.
157 },
158 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
159 # different programming environments, including REST APIs and RPC APIs. It is
160 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
161 # three pieces of data: error code, error message, and error details.
162 #
163 # You can find out more about this error model and how to work with it in the
164 # [API Design Guide](https://cloud.google.com/apis/design/errors).
165 "message": "A String", # A developer-facing error message, which should be in English. Any
166 # user-facing error message should be localized and sent in the
167 # google.rpc.Status.details field, or localized by the client.
168 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
169 "details": [ # A list of messages that carry the error details. There is a common set of
170 # message types for APIs to use.
171 {
172 "a_key": "", # Properties of the object. Contains field @type with type URL.
173 },
174 ],
175 },
176 "done": True or False, # If the value is `false`, it means the operation is still in progress.
177 # If `true`, the operation is completed, and either `error` or `response` is
178 # available.
179 "response": { # The normal response of the operation in case of success. If the original
180 # method returns no data on success, such as `Delete`, the response is
181 # `google.protobuf.Empty`. If the original method is standard
182 # `Get`/`Create`/`Update`, the response should be the resource. For other
183 # methods, the response should have the type `XxxResponse`, where `Xxx`
184 # is the original method name. For example, if the original method name
185 # is `TakeSnapshot()`, the inferred response type is
186 # `TakeSnapshotResponse`.
187 "a_key": "", # Properties of the object. Contains field @type with type URL.
188 },
189 "name": "A String", # The server-assigned name, which is only unique within the same service that
190 # originally returns it. If you use the default HTTP mapping, the
191 # `name` should be a resource name ending with `operations/{unique_id}`.
192 }</pre>
193</div>
194
195<div class="method">
196 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
197 <pre>Deletes a Membership.
198
199Args:
200 name: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the
201Membership to be deleted.
202
203Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is
204the unique ID assigned to the Group to which Membership belongs to, and
205member_id is the unique ID assigned to the member. (required)
206 x__xgafv: string, V1 error format.
207 Allowed values
208 1 - v1 error format
209 2 - v2 error format
210
211Returns:
212 An object of the form:
213
214 { # This resource represents a long-running operation that is the result of a
215 # network API call.
216 "metadata": { # Service-specific metadata associated with the operation. It typically
217 # contains progress information and common metadata such as create time.
218 # Some services might not provide such metadata. Any method that returns a
219 # long-running operation should document the metadata type, if any.
220 "a_key": "", # Properties of the object. Contains field @type with type URL.
221 },
222 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
223 # different programming environments, including REST APIs and RPC APIs. It is
224 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
225 # three pieces of data: error code, error message, and error details.
226 #
227 # You can find out more about this error model and how to work with it in the
228 # [API Design Guide](https://cloud.google.com/apis/design/errors).
229 "message": "A String", # A developer-facing error message, which should be in English. Any
230 # user-facing error message should be localized and sent in the
231 # google.rpc.Status.details field, or localized by the client.
232 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
233 "details": [ # A list of messages that carry the error details. There is a common set of
234 # message types for APIs to use.
235 {
236 "a_key": "", # Properties of the object. Contains field @type with type URL.
237 },
238 ],
239 },
240 "done": True or False, # If the value is `false`, it means the operation is still in progress.
241 # If `true`, the operation is completed, and either `error` or `response` is
242 # available.
243 "response": { # The normal response of the operation in case of success. If the original
244 # method returns no data on success, such as `Delete`, the response is
245 # `google.protobuf.Empty`. If the original method is standard
246 # `Get`/`Create`/`Update`, the response should be the resource. For other
247 # methods, the response should have the type `XxxResponse`, where `Xxx`
248 # is the original method name. For example, if the original method name
249 # is `TakeSnapshot()`, the inferred response type is
250 # `TakeSnapshotResponse`.
251 "a_key": "", # Properties of the object. Contains field @type with type URL.
252 },
253 "name": "A String", # The server-assigned name, which is only unique within the same service that
254 # originally returns it. If you use the default HTTP mapping, the
255 # `name` should be a resource name ending with `operations/{unique_id}`.
256 }</pre>
257</div>
258
259<div class="method">
260 <code class="details" id="get">get(name, x__xgafv=None)</code>
261 <pre>Retrieves a Membership.
262
263Args:
264 name: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the
265Membership to be retrieved.
266
267Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is
268the unique id assigned to the Group to which Membership belongs to, and
269`member_id` is the unique ID assigned to the member. (required)
270 x__xgafv: string, V1 error format.
271 Allowed values
272 1 - v1 error format
273 2 - v2 error format
274
275Returns:
276 An object of the form:
277
278 { # Resource representing a Membership within a Group
279 "updateTime": "A String", # Last updated timestamp of the Membership. Output only.
280 "preferredMemberKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # EntityKey of the entity to be added as the member. Must be set while
281 # creating a Membership, read-only afterwards.
282 #
283 # Currently allowed entity types: `Users`, `Groups`.
284 # isolation for IDs. A single ID can be reused across namespaces but the
285 # combination of a namespace and an ID must be unique.
286 "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique
287 # within its namespace.
288 #
289 # Namespaces are currently only created as part of IdentitySource creation
290 # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
291 # created corresponding to every Identity Source `identity_source_id`.
292 "id": "A String", # The ID of the entity within the given namespace. The ID must be unique
293 # within its namespace.
294 },
295 "createTime": "A String", # Creation timestamp of the Membership. Output only.
296 "roles": [ # Roles for a member within the Group.
297 #
298 # Currently supported MembershipRoles: `"MEMBER"`.
299 { # Resource representing a role within a Membership.
300 "name": "A String", # MembershipRole in string format.
301 #
302 # Currently supported MembershipRoles: `"MEMBER"`.
303 },
304 ],
305 "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the
306 # Membership in the format: `groups/{group_id}/memberships/{member_id}`,
307 # where group_id is the unique ID assigned to the Group to which Membership
308 # belongs to, and member_id is the unique ID assigned to the member
309 #
310 # Must be left blank while creating a Membership.
311 }</pre>
312</div>
313
314<div class="method">
315 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, view=None)</code>
316 <pre>List Memberships within a Group.
317
318Args:
319 parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the
320Group to list Memberships within.
321
322Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to
323the Group. (required)
324 pageToken: string, The next_page_token value returned from a previous list request, if any.
325 x__xgafv: string, V1 error format.
326 Allowed values
327 1 - v1 error format
328 2 - v2 error format
329 pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50
330(max 500) for the FULL view.
331 view: string, Membership resource view to be returned. Defaults to View.BASIC.
332
333Returns:
334 An object of the form:
335
336 {
337 "memberships": [ # List of Memberships.
338 { # Resource representing a Membership within a Group
339 "updateTime": "A String", # Last updated timestamp of the Membership. Output only.
340 "preferredMemberKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # EntityKey of the entity to be added as the member. Must be set while
341 # creating a Membership, read-only afterwards.
342 #
343 # Currently allowed entity types: `Users`, `Groups`.
344 # isolation for IDs. A single ID can be reused across namespaces but the
345 # combination of a namespace and an ID must be unique.
346 "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique
347 # within its namespace.
348 #
349 # Namespaces are currently only created as part of IdentitySource creation
350 # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
351 # created corresponding to every Identity Source `identity_source_id`.
352 "id": "A String", # The ID of the entity within the given namespace. The ID must be unique
353 # within its namespace.
354 },
355 "createTime": "A String", # Creation timestamp of the Membership. Output only.
356 "roles": [ # Roles for a member within the Group.
357 #
358 # Currently supported MembershipRoles: `"MEMBER"`.
359 { # Resource representing a role within a Membership.
360 "name": "A String", # MembershipRole in string format.
361 #
362 # Currently supported MembershipRoles: `"MEMBER"`.
363 },
364 ],
365 "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the
366 # Membership in the format: `groups/{group_id}/memberships/{member_id}`,
367 # where group_id is the unique ID assigned to the Group to which Membership
368 # belongs to, and member_id is the unique ID assigned to the member
369 #
370 # Must be left blank while creating a Membership.
371 },
372 ],
373 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
374 # more results available for listing.
375 }</pre>
376</div>
377
378<div class="method">
379 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
380 <pre>Retrieves the next page of results.
381
382Args:
383 previous_request: The request for the previous page. (required)
384 previous_response: The response from the request for the previous page. (required)
385
386Returns:
387 A request object that you can call 'execute()' on to request the next
388 page. Returns None if there are no more items in the collection.
389 </pre>
390</div>
391
392<div class="method">
393 <code class="details" id="lookup">lookup(parent, memberKey_namespace=None, memberKey_id=None, x__xgafv=None)</code>
394 <pre>Looks up [resource
395name](https://cloud.google.com/apis/design/resource_names) of a Membership
396within a Group by member's EntityKey.
397
398Args:
399 parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the
400Group to lookup Membership within.
401
402Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to
403the Group. (required)
404 memberKey_namespace: string, Namespaces provide isolation for IDs, so an ID only needs to be unique
405within its namespace.
406
407Namespaces are currently only created as part of IdentitySource creation
408from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
409created corresponding to every Identity Source `identity_source_id`.
410 memberKey_id: string, The ID of the entity within the given namespace. The ID must be unique
411within its namespace.
412 x__xgafv: string, V1 error format.
413 Allowed values
414 1 - v1 error format
415 2 - v2 error format
416
417Returns:
418 An object of the form:
419
420 {
421 "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the
422 # Membership being looked up.
423 #
424 # Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is
425 # the unique ID assigned to the Group to which Membership belongs to, and
426 # `member_id` is the unique ID assigned to the member.
427 }</pre>
428</div>
429
430</body></html>