Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / cloudidentity_v1beta1.groups.memberships.html
blob: fda4154916fcea2cfc86d691404822989cff4708 [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_v1beta1.html">Cloud Identity API</a> . <a href="cloudidentity_v1beta1.groups.html">groups</a> . <a href="cloudidentity_v1beta1.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, pageSize=None, pageToken=None, x__xgafv=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 "roles": [ # Roles for a member within the Group.
109 #
110 # Currently supported MembershipRoles: `"MEMBER"`.
111 { # Resource representing a role within a Membership.
112 "name": "A String", # MembershipRole in string format.
113 #
114 # Currently supported MembershipRoles: `"MEMBER"`.
115 },
116 ],
117 "memberKey": { # 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
118 # creating a Membership, read-only afterwards.
119 #
120 # Currently allowed entity types: `Users`, `Groups`.
121 # isolation for ids. A single Id can be reused across namespaces but the
122 # combination of a namespace and an id must be unique.
123 "namespace": "A String", # Namespaces provide isolation for ids, i.e an id only needs to be unique
124 # within its namespace.
125 #
126 # Namespaces are currently only created as part of IdentitySource creation
127 # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
128 # created corresponding to every Identity Source `identity_source_id`.
129 "id": "A String", # The id of the entity within the given namespace. The id must be unique
130 # within its namespace.
131 },
132 "createTime": "A String", # Creation timestamp of the Membership.
133 "updateTime": "A String", # Last updated timestamp of the Membership.
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 "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.
153 # different programming environments, including REST APIs and RPC APIs. It is
154 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
155 # three pieces of data: error code, error message, and error details.
156 #
157 # You can find out more about this error model and how to work with it in the
158 # [API Design Guide](https://cloud.google.com/apis/design/errors).
159 "message": "A String", # A developer-facing error message, which should be in English. Any
160 # user-facing error message should be localized and sent in the
161 # google.rpc.Status.details field, or localized by the client.
162 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
163 "details": [ # A list of messages that carry the error details. There is a common set of
164 # message types for APIs to use.
165 {
166 "a_key": "", # Properties of the object. Contains field @type with type URL.
167 },
168 ],
169 },
170 "done": True or False, # If the value is `false`, it means the operation is still in progress.
171 # If `true`, the operation is completed, and either `error` or `response` is
172 # available.
173 "response": { # The normal response of the operation in case of success. If the original
174 # method returns no data on success, such as `Delete`, the response is
175 # `google.protobuf.Empty`. If the original method is standard
176 # `Get`/`Create`/`Update`, the response should be the resource. For other
177 # methods, the response should have the type `XxxResponse`, where `Xxx`
178 # is the original method name. For example, if the original method name
179 # is `TakeSnapshot()`, the inferred response type is
180 # `TakeSnapshotResponse`.
181 "a_key": "", # Properties of the object. Contains field @type with type URL.
182 },
183 "name": "A String", # The server-assigned name, which is only unique within the same service that
184 # originally returns it. If you use the default HTTP mapping, the
185 # `name` should be a resource name ending with `operations/{unique_id}`.
186 "metadata": { # Service-specific metadata associated with the operation. It typically
187 # contains progress information and common metadata such as create time.
188 # Some services might not provide such metadata. Any method that returns a
189 # long-running operation should document the metadata type, if any.
190 "a_key": "", # Properties of the object. Contains field @type with type URL.
191 },
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 "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.
217 # different programming environments, including REST APIs and RPC APIs. It is
218 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
219 # three pieces of data: error code, error message, and error details.
220 #
221 # You can find out more about this error model and how to work with it in the
222 # [API Design Guide](https://cloud.google.com/apis/design/errors).
223 "message": "A String", # A developer-facing error message, which should be in English. Any
224 # user-facing error message should be localized and sent in the
225 # google.rpc.Status.details field, or localized by the client.
226 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
227 "details": [ # A list of messages that carry the error details. There is a common set of
228 # message types for APIs to use.
229 {
230 "a_key": "", # Properties of the object. Contains field @type with type URL.
231 },
232 ],
233 },
234 "done": True or False, # If the value is `false`, it means the operation is still in progress.
235 # If `true`, the operation is completed, and either `error` or `response` is
236 # available.
237 "response": { # The normal response of the operation in case of success. If the original
238 # method returns no data on success, such as `Delete`, the response is
239 # `google.protobuf.Empty`. If the original method is standard
240 # `Get`/`Create`/`Update`, the response should be the resource. For other
241 # methods, the response should have the type `XxxResponse`, where `Xxx`
242 # is the original method name. For example, if the original method name
243 # is `TakeSnapshot()`, the inferred response type is
244 # `TakeSnapshotResponse`.
245 "a_key": "", # Properties of the object. Contains field @type with type URL.
246 },
247 "name": "A String", # The server-assigned name, which is only unique within the same service that
248 # originally returns it. If you use the default HTTP mapping, the
249 # `name` should be a resource name ending with `operations/{unique_id}`.
250 "metadata": { # Service-specific metadata associated with the operation. It typically
251 # contains progress information and common metadata such as create time.
252 # Some services might not provide such metadata. Any method that returns a
253 # long-running operation should document the metadata type, if any.
254 "a_key": "", # Properties of the object. Contains field @type with type URL.
255 },
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 "roles": [ # Roles for a member within the Group.
280 #
281 # Currently supported MembershipRoles: `"MEMBER"`.
282 { # Resource representing a role within a Membership.
283 "name": "A String", # MembershipRole in string format.
284 #
285 # Currently supported MembershipRoles: `"MEMBER"`.
286 },
287 ],
288 "memberKey": { # 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
289 # creating a Membership, read-only afterwards.
290 #
291 # Currently allowed entity types: `Users`, `Groups`.
292 # isolation for ids. A single Id can be reused across namespaces but the
293 # combination of a namespace and an id must be unique.
294 "namespace": "A String", # Namespaces provide isolation for ids, i.e an id only needs to be unique
295 # within its namespace.
296 #
297 # Namespaces are currently only created as part of IdentitySource creation
298 # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
299 # created corresponding to every Identity Source `identity_source_id`.
300 "id": "A String", # The id of the entity within the given namespace. The id must be unique
301 # within its namespace.
302 },
303 "createTime": "A String", # Creation timestamp of the Membership.
304 "updateTime": "A String", # Last updated timestamp of the Membership.
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, pageSize=None, pageToken=None, x__xgafv=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 pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50
325(max 500) for the FULL view.
326 pageToken: string, The next_page_token value returned from a previous list request, if any
327 x__xgafv: string, V1 error format.
328 Allowed values
329 1 - v1 error format
330 2 - v2 error format
331 view: string, Membership resource view to be returned. Defaults to MembershipView.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 "roles": [ # Roles for a member within the Group.
340 #
341 # Currently supported MembershipRoles: `"MEMBER"`.
342 { # Resource representing a role within a Membership.
343 "name": "A String", # MembershipRole in string format.
344 #
345 # Currently supported MembershipRoles: `"MEMBER"`.
346 },
347 ],
348 "memberKey": { # 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
349 # creating a Membership, read-only afterwards.
350 #
351 # Currently allowed entity types: `Users`, `Groups`.
352 # isolation for ids. A single Id can be reused across namespaces but the
353 # combination of a namespace and an id must be unique.
354 "namespace": "A String", # Namespaces provide isolation for ids, i.e an id only needs to be unique
355 # within its namespace.
356 #
357 # Namespaces are currently only created as part of IdentitySource creation
358 # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
359 # created corresponding to every Identity Source `identity_source_id`.
360 "id": "A String", # The id of the entity within the given namespace. The id must be unique
361 # within its namespace.
362 },
363 "createTime": "A String", # Creation timestamp of the Membership.
364 "updateTime": "A String", # Last updated timestamp of the Membership.
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, i.e 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>