blob: 61a73798a796bd3c5092ad63f192c6190545d5eb [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070087 <code><a href="#list">list(parent, pageSize=None, view=None, pageToken=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070088<p class="firstline">Lists Memberships within a Group.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070089<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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070093 <code><a href="#lookup">lookup(parent, memberKey_namespace=None, memberKey_id=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Looks up [resource</p>
95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070097 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098 <pre>Creates a Membership.
99
100Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700101 parent: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700102Group to create Membership within. Format: `groups/{group_id}`, where
103`group_id` is the unique ID assigned to the Group. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700104 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700105 The object takes the form of:
106
107{ # Resource representing a Membership within a Group
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700108 &quot;roles&quot;: [ # Roles for a member within the Group.
109 #
110 # Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
111 { # Resource representing a role within a Membership.
112 &quot;name&quot;: &quot;A String&quot;, # MembershipRole in string format.
113 #
114 # Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
115 },
116 ],
117 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
118 # Membership in the format: `groups/{group_id}/memberships/{member_id}`,
119 # where group_id is the unique ID assigned to the Group to which Membership
120 # belongs to, and member_id is the unique ID assigned to the member
121 #
122 # Must be left blank while creating a Membership.
123 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last updated timestamp of the Membership. Output only.
124 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp of the Membership. Output only.
125 &quot;preferredMemberKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the entity to be added as the member. Must be set while
126 # creating a Membership, read-only afterwards.
127 #
128 # Currently allowed entity types: `Users`, `Groups`.
129 # isolation for IDs. A single ID can be reused across namespaces but the
130 # combination of a namespace and an ID must be unique.
131 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique
132 # within its namespace.
133 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique
134 # within its namespace.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700135 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700136 # Namespaces are currently only created as part of IdentitySource creation
137 # from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
138 # created corresponding to every Identity Source `identity_source_id`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700139 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700140 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700141
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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700152 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700153 # method returns no data on success, such as `Delete`, the response is
154 # `google.protobuf.Empty`. If the original method is standard
155 # `Get`/`Create`/`Update`, the response should be the resource. For other
156 # methods, the response should have the type `XxxResponse`, where `Xxx`
157 # is the original method name. For example, if the original method name
158 # is `TakeSnapshot()`, the inferred response type is
159 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700160 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700161 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700162 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
163 # If `true`, the operation is completed, and either `error` or `response` is
164 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700165 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
166 # contains progress information and common metadata such as create time.
167 # Some services might not provide such metadata. Any method that returns a
168 # long-running operation should document the metadata type, if any.
169 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
170 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700171 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
172 # originally returns it. If you use the default HTTP mapping, the
173 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700174 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
175 # different programming environments, including REST APIs and RPC APIs. It is
176 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
177 # three pieces of data: error code, error message, and error details.
178 #
179 # You can find out more about this error model and how to work with it in the
180 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700181 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
182 # message types for APIs to use.
183 {
184 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
185 },
186 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700187 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
188 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
189 # user-facing error message should be localized and sent in the
190 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700191 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700192 }</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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700200 name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700201Membership 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700216 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700217 # method returns no data on success, such as `Delete`, the response is
218 # `google.protobuf.Empty`. If the original method is standard
219 # `Get`/`Create`/`Update`, the response should be the resource. For other
220 # methods, the response should have the type `XxxResponse`, where `Xxx`
221 # is the original method name. For example, if the original method name
222 # is `TakeSnapshot()`, the inferred response type is
223 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700224 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700225 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700226 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
227 # If `true`, the operation is completed, and either `error` or `response` is
228 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700229 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
230 # contains progress information and common metadata such as create time.
231 # Some services might not provide such metadata. Any method that returns a
232 # long-running operation should document the metadata type, if any.
233 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
234 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700235 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
236 # originally returns it. If you use the default HTTP mapping, the
237 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700238 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
239 # different programming environments, including REST APIs and RPC APIs. It is
240 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
241 # three pieces of data: error code, error message, and error details.
242 #
243 # You can find out more about this error model and how to work with it in the
244 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700245 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
246 # message types for APIs to use.
247 {
248 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
249 },
250 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700251 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
252 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
253 # user-facing error message should be localized and sent in the
254 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700255 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700256 }</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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700264 name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700265Membership 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
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700279 &quot;roles&quot;: [ # Roles for a member within the Group.
Dan O'Mearadd494642020-05-01 07:42:23 -0700280 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700281 # Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
282 { # Resource representing a role within a Membership.
283 &quot;name&quot;: &quot;A String&quot;, # MembershipRole in string format.
284 #
285 # Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
286 },
287 ],
288 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
289 # Membership in the format: `groups/{group_id}/memberships/{member_id}`,
290 # where group_id is the unique ID assigned to the Group to which Membership
291 # belongs to, and member_id is the unique ID assigned to the member
292 #
293 # Must be left blank while creating a Membership.
294 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last updated timestamp of the Membership. Output only.
295 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp of the Membership. Output only.
296 &quot;preferredMemberKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the entity to be added as the member. Must be set while
297 # creating a Membership, read-only afterwards.
298 #
299 # Currently allowed entity types: `Users`, `Groups`.
300 # isolation for IDs. A single ID can be reused across namespaces but the
301 # combination of a namespace and an ID must be unique.
302 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique
303 # within its namespace.
304 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique
305 # within its namespace.
306 #
307 # Namespaces are currently only created as part of IdentitySource creation
308 # from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
309 # created corresponding to every Identity Source `identity_source_id`.
310 },
311 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700312</div>
313
314<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700315 <code class="details" id="list">list(parent, pageSize=None, view=None, pageToken=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700316 <pre>Lists Memberships within a Group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700317
318Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700319 parent: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700320Group to list Memberships within.
321
322Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to
323the Group. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700324 pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50
325(max 500) for the FULL view.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700326 view: string, Membership resource view to be returned. Defaults to View.BASIC.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700327 pageToken: string, The next_page_token value returned from a previous list request, if any.
328 x__xgafv: string, V1 error format.
329 Allowed values
330 1 - v1 error format
331 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700332
333Returns:
334 An object of the form:
335
336 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700337 &quot;memberships&quot;: [ # List of Memberships.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700338 { # Resource representing a Membership within a Group
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700339 &quot;roles&quot;: [ # Roles for a member within the Group.
Dan O'Mearadd494642020-05-01 07:42:23 -0700340 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700341 # Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
342 { # Resource representing a role within a Membership.
343 &quot;name&quot;: &quot;A String&quot;, # MembershipRole in string format.
344 #
345 # Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
346 },
347 ],
348 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
349 # Membership in the format: `groups/{group_id}/memberships/{member_id}`,
350 # where group_id is the unique ID assigned to the Group to which Membership
351 # belongs to, and member_id is the unique ID assigned to the member
352 #
353 # Must be left blank while creating a Membership.
354 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last updated timestamp of the Membership. Output only.
355 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp of the Membership. Output only.
356 &quot;preferredMemberKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the entity to be added as the member. Must be set while
357 # creating a Membership, read-only afterwards.
358 #
359 # Currently allowed entity types: `Users`, `Groups`.
360 # isolation for IDs. A single ID can be reused across namespaces but the
361 # combination of a namespace and an ID must be unique.
362 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique
363 # within its namespace.
364 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique
365 # within its namespace.
366 #
367 # Namespaces are currently only created as part of IdentitySource creation
368 # from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
369 # created corresponding to every Identity Source `identity_source_id`.
370 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700371 },
372 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700373 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
374 # more results available for listing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700375 }</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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700387 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700388 page. Returns None if there are no more items in the collection.
389 </pre>
390</div>
391
392<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700393 <code class="details" id="lookup">lookup(parent, memberKey_namespace=None, memberKey_id=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700394 <pre>Looks up [resource
395name](https://cloud.google.com/apis/design/resource_names) of a Membership
Bu Sun Kim65020912020-05-20 12:08:20 -0700396within a Group by member&#x27;s EntityKey.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700397
398Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700399 parent: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700400Group 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
Bu Sun Kim65020912020-05-20 12:08:20 -0700408from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700409created corresponding to every Identity Source `identity_source_id`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700410 memberKey_id: string, The ID of the entity within the given namespace. The ID must be unique
411within its namespace.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700412 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 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700421 &quot;name&quot;: &quot;A String&quot;, # [Resource name](https://cloud.google.com/apis/design/resource_names) of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700422 # 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>