Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ed7d3f9b61ac35e08a22b4995076a95451cf7c8 / . / docs / dyn / cloudidentity_v1beta1.groups.memberships.html
blob: 7310699e8b1e991efe83f6e9dd575a537d87c9d0 [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a `Membership`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]82<p class="firstline">Deletes a `Membership`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]85<p class="firstline">Retrieves a `Membership`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87 <code><a href="#list">list(parent, pageToken=None, view=None, pageSize=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]88<p class="firstline">Lists the `Membership`s within a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]93 <code><a href="#lookup">lookup(parent, memberKey_id=None, memberKey_namespace=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]94<p class="firstline">Looks up the [resource</p>
95<p class="toc_element">
96 <code><a href="#modifyMembershipRoles">modifyMembershipRoles(name, body=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Modifies the `MembershipRole`s of a `Membership`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]100 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
101 <pre>Creates a `Membership`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102
103Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104 parent: string, Required. The parent `Group` resource under which to create the `Membership`.
105
106Must be of the form `groups/{group_id}`. (required)
107 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 The object takes the form of:
109
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]110{ # A membership within the Cloud Identity Groups API.
111 #
112 # A `Membership` defines a relationship between a `Group` and an entity
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 # belonging to that `Group`, referred to as a &quot;member&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]114 &quot;memberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Immutable. The `EntityKey` of the member.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 #
116 # Either `member_key` or `preferred_member_key` must be set when calling
117 # MembershipsService.CreateMembership but not both; both shall be set
118 # when returned.
119 #
120 # An entity can represent either a group with an optional `namespace` or a user
121 # without a `namespace`. The combination of `id` and `namespace` must be
122 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
124 #
125 # For Google-managed entities, the `id` must be the email address of an
126 # existing group or user.
127 #
128 # For external-identity-mapped entities, the `id` must be a string conforming
129 # to the Identity Source&#x27;s requirements.
130 #
131 # Must be unique within a `namespace`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]132 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
133 #
134 # If not specified, the `EntityKey` represents a Google-managed entity such
135 # as a Google user or a Google Group.
136 #
137 # If specified, the `EntityKey` represents an external-identity-mapped group.
138 # The namespace must correspond to an identity source created in Admin
139 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]141 &quot;preferredMemberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the member.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]142 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]143 # Either `member_key` or `preferred_member_key` must be set when calling
144 # MembershipsService.CreateMembership but not both; both shall be set
145 # when returned.
146 #
147 # An entity can represent either a group with an optional `namespace` or a user
148 # without a `namespace`. The combination of `id` and `namespace` must be
149 # unique; however, the same `id` can be used with different `namespace`s.
150 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
151 #
152 # For Google-managed entities, the `id` must be the email address of an
153 # existing group or user.
154 #
155 # For external-identity-mapped entities, the `id` must be a string conforming
156 # to the Identity Source&#x27;s requirements.
157 #
158 # Must be unique within a `namespace`.
159 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
160 #
161 # If not specified, the `EntityKey` represents a Google-managed entity such
162 # as a Google user or a Google Group.
163 #
164 # If specified, the `EntityKey` represents an external-identity-mapped group.
165 # The namespace must correspond to an identity source created in Admin
166 # Console and must be in the form of `identitysources/{identity_source_id}.
167 },
168 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
169 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]170 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]171 #
172 # If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`.
173 #
174 # Must not contain duplicate `MembershipRole`s with the same `name`.
175 { # A membership role within the Cloud Identity Groups API.
176 #
177 # A `MembershipRole` defines the privileges granted to a `Membership`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]178 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]179 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]180 # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]182 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]183 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
184 # the `Membership`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]185 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]186 # Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]187}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188
189 x__xgafv: string, V1 error format.
190 Allowed values
191 1 - v1 error format
192 2 - v2 error format
193
194Returns:
195 An object of the form:
196
197 { # This resource represents a long-running operation that is the result of a
198 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]199 &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.
200 # different programming environments, including REST APIs and RPC APIs. It is
201 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
202 # three pieces of data: error code, error message, and error details.
203 #
204 # You can find out more about this error model and how to work with it in the
205 # [API Design Guide](https://cloud.google.com/apis/design/errors).
206 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
207 # user-facing error message should be localized and sent in the
208 # google.rpc.Status.details field, or localized by the client.
209 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
210 # message types for APIs to use.
211 {
212 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
213 },
214 ],
215 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
216 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]217 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
218 # contains progress information and common metadata such as create time.
219 # Some services might not provide such metadata. Any method that returns a
220 # long-running operation should document the metadata type, if any.
221 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
222 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]223 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
224 # originally returns it. If you use the default HTTP mapping, the
225 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]226 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]227 # method returns no data on success, such as `Delete`, the response is
228 # `google.protobuf.Empty`. If the original method is standard
229 # `Get`/`Create`/`Update`, the response should be the resource. For other
230 # methods, the response should have the type `XxxResponse`, where `Xxx`
231 # is the original method name. For example, if the original method name
232 # is `TakeSnapshot()`, the inferred response type is
233 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]234 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]235 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]236 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
237 # If `true`, the operation is completed, and either `error` or `response` is
238 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]239 }</pre>
240</div>
241
242<div class="method">
243 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]244 <pre>Deletes a `Membership`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]245
246Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]247 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of
248the `Membership` to delete.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]250Must be of the form `groups/{group_id}/memberships/{membership_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]251 x__xgafv: string, V1 error format.
252 Allowed values
253 1 - v1 error format
254 2 - v2 error format
255
256Returns:
257 An object of the form:
258
259 { # This resource represents a long-running operation that is the result of a
260 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]261 &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.
262 # different programming environments, including REST APIs and RPC APIs. It is
263 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
264 # three pieces of data: error code, error message, and error details.
265 #
266 # You can find out more about this error model and how to work with it in the
267 # [API Design Guide](https://cloud.google.com/apis/design/errors).
268 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
269 # user-facing error message should be localized and sent in the
270 # google.rpc.Status.details field, or localized by the client.
271 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
272 # message types for APIs to use.
273 {
274 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
275 },
276 ],
277 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
278 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]279 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
280 # contains progress information and common metadata such as create time.
281 # Some services might not provide such metadata. Any method that returns a
282 # long-running operation should document the metadata type, if any.
283 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
284 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]285 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
286 # originally returns it. If you use the default HTTP mapping, the
287 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]288 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]289 # method returns no data on success, such as `Delete`, the response is
290 # `google.protobuf.Empty`. If the original method is standard
291 # `Get`/`Create`/`Update`, the response should be the resource. For other
292 # methods, the response should have the type `XxxResponse`, where `Xxx`
293 # is the original method name. For example, if the original method name
294 # is `TakeSnapshot()`, the inferred response type is
295 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]296 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]297 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]298 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
299 # If `true`, the operation is completed, and either `error` or `response` is
300 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]301 }</pre>
302</div>
303
304<div class="method">
305 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]306 <pre>Retrieves a `Membership`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307
308Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]309 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of
310the `Membership` to retrieve.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]311
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]312Must be of the form `groups/{group_id}/memberships/{membership_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]313 x__xgafv: string, V1 error format.
314 Allowed values
315 1 - v1 error format
316 2 - v2 error format
317
318Returns:
319 An object of the form:
320
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]321 { # A membership within the Cloud Identity Groups API.
322 #
323 # A `Membership` defines a relationship between a `Group` and an entity
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]324 # belonging to that `Group`, referred to as a &quot;member&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]325 &quot;memberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Immutable. The `EntityKey` of the member.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]326 #
327 # Either `member_key` or `preferred_member_key` must be set when calling
328 # MembershipsService.CreateMembership but not both; both shall be set
329 # when returned.
330 #
331 # An entity can represent either a group with an optional `namespace` or a user
332 # without a `namespace`. The combination of `id` and `namespace` must be
333 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]334 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
335 #
336 # For Google-managed entities, the `id` must be the email address of an
337 # existing group or user.
338 #
339 # For external-identity-mapped entities, the `id` must be a string conforming
340 # to the Identity Source&#x27;s requirements.
341 #
342 # Must be unique within a `namespace`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]343 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
344 #
345 # If not specified, the `EntityKey` represents a Google-managed entity such
346 # as a Google user or a Google Group.
347 #
348 # If specified, the `EntityKey` represents an external-identity-mapped group.
349 # The namespace must correspond to an identity source created in Admin
350 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]351 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]352 &quot;preferredMemberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the member.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]353 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]354 # Either `member_key` or `preferred_member_key` must be set when calling
355 # MembershipsService.CreateMembership but not both; both shall be set
356 # when returned.
357 #
358 # An entity can represent either a group with an optional `namespace` or a user
359 # without a `namespace`. The combination of `id` and `namespace` must be
360 # unique; however, the same `id` can be used with different `namespace`s.
361 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
362 #
363 # For Google-managed entities, the `id` must be the email address of an
364 # existing group or user.
365 #
366 # For external-identity-mapped entities, the `id` must be a string conforming
367 # to the Identity Source&#x27;s requirements.
368 #
369 # Must be unique within a `namespace`.
370 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
371 #
372 # If not specified, the `EntityKey` represents a Google-managed entity such
373 # as a Google user or a Google Group.
374 #
375 # If specified, the `EntityKey` represents an external-identity-mapped group.
376 # The namespace must correspond to an identity source created in Admin
377 # Console and must be in the form of `identitysources/{identity_source_id}.
378 },
379 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
380 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]381 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]382 #
383 # If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`.
384 #
385 # Must not contain duplicate `MembershipRole`s with the same `name`.
386 { # A membership role within the Cloud Identity Groups API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]387 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]388 # A `MembershipRole` defines the privileges granted to a `Membership`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]389 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]391 # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]392 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]393 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]394 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
395 # the `Membership`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]396 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]397 # Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]398 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399</div>
400
401<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]402 <code class="details" id="list">list(parent, pageToken=None, view=None, pageSize=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]403 <pre>Lists the `Membership`s within a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]404
405Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]406 parent: string, Required. The parent `Group` resource under which to lookup the `Membership` name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]407
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]408Must be of the form `groups/{group_id}`. (required)
409 pageToken: string, The `next_page_token` value returned from a previous search request, if
410any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]411 view: string, The level of detail to be returned.
412
413If unspecified, defaults to `MembershipView.BASIC`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]414 pageSize: integer, The maximum number of results to return.
415
416Note that the number of results returned may be less than this value even
417if there are more available results. To fetch all results, clients must
418continue calling this method repeatedly until the response no longer
419contains a `next_page_token`.
420
421If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for
422`GroupView.FULL`.
423
424Must not be greater than 1000 for `GroupView.BASIC` or 500 for
425`GroupView.FULL`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]426 x__xgafv: string, V1 error format.
427 Allowed values
428 1 - v1 error format
429 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]430
431Returns:
432 An object of the form:
433
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]434 { # The response message for MembershipsService.ListMemberships.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]435 &quot;memberships&quot;: [ # The `Membership`s under the specified `parent`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]436 { # A membership within the Cloud Identity Groups API.
437 #
438 # A `Membership` defines a relationship between a `Group` and an entity
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]439 # belonging to that `Group`, referred to as a &quot;member&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]440 &quot;memberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Immutable. The `EntityKey` of the member.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]441 #
442 # Either `member_key` or `preferred_member_key` must be set when calling
443 # MembershipsService.CreateMembership but not both; both shall be set
444 # when returned.
445 #
446 # An entity can represent either a group with an optional `namespace` or a user
447 # without a `namespace`. The combination of `id` and `namespace` must be
448 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]449 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
450 #
451 # For Google-managed entities, the `id` must be the email address of an
452 # existing group or user.
453 #
454 # For external-identity-mapped entities, the `id` must be a string conforming
455 # to the Identity Source&#x27;s requirements.
456 #
457 # Must be unique within a `namespace`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]458 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
459 #
460 # If not specified, the `EntityKey` represents a Google-managed entity such
461 # as a Google user or a Google Group.
462 #
463 # If specified, the `EntityKey` represents an external-identity-mapped group.
464 # The namespace must correspond to an identity source created in Admin
465 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]466 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]467 &quot;preferredMemberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the member.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]468 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]469 # Either `member_key` or `preferred_member_key` must be set when calling
470 # MembershipsService.CreateMembership but not both; both shall be set
471 # when returned.
472 #
473 # An entity can represent either a group with an optional `namespace` or a user
474 # without a `namespace`. The combination of `id` and `namespace` must be
475 # unique; however, the same `id` can be used with different `namespace`s.
476 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
477 #
478 # For Google-managed entities, the `id` must be the email address of an
479 # existing group or user.
480 #
481 # For external-identity-mapped entities, the `id` must be a string conforming
482 # to the Identity Source&#x27;s requirements.
483 #
484 # Must be unique within a `namespace`.
485 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
486 #
487 # If not specified, the `EntityKey` represents a Google-managed entity such
488 # as a Google user or a Google Group.
489 #
490 # If specified, the `EntityKey` represents an external-identity-mapped group.
491 # The namespace must correspond to an identity source created in Admin
492 # Console and must be in the form of `identitysources/{identity_source_id}.
493 },
494 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
495 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]496 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]497 #
498 # If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`.
499 #
500 # Must not contain duplicate `MembershipRole`s with the same `name`.
501 { # A membership role within the Cloud Identity Groups API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]502 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]503 # A `MembershipRole` defines the privileges granted to a `Membership`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]504 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]505 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]506 # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]507 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]508 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]509 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
510 # the `Membership`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]511 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]512 # Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]513 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]514 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]515 &quot;nextPageToken&quot;: &quot;A String&quot;, # A continuation token to retrieve the next page of results, or empty if
516 # there are no more results available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]517 }</pre>
518</div>
519
520<div class="method">
521 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
522 <pre>Retrieves the next page of results.
523
524Args:
525 previous_request: The request for the previous page. (required)
526 previous_response: The response from the request for the previous page. (required)
527
528Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]529 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]530 page. Returns None if there are no more items in the collection.
531 </pre>
532</div>
533
534<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]535 <code class="details" id="lookup">lookup(parent, memberKey_id=None, memberKey_namespace=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]536 <pre>Looks up the [resource
537name](https://cloud.google.com/apis/design/resource_names) of a
538`Membership` by its `EntityKey`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]539
540Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]541 parent: string, Required. The parent `Group` resource under which to lookup the `Membership` name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]542
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]543Must be of the form `groups/{group_id}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]544 memberKey_id: string, The ID of the entity.
545
546For Google-managed entities, the `id` must be the email address of an
547existing group or user.
548
549For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]550to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]551
552Must be unique within a `namespace`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]553 memberKey_namespace: string, The namespace in which the entity exists.
554
555If not specified, the `EntityKey` represents a Google-managed entity such
556as a Google user or a Google Group.
557
558If specified, the `EntityKey` represents an external-identity-mapped group.
559The namespace must correspond to an identity source created in Admin
560Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]561 x__xgafv: string, V1 error format.
562 Allowed values
563 1 - v1 error format
564 2 - v2 error format
565
566Returns:
567 An object of the form:
568
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]569 { # The response message for MembershipsService.LookupMembershipName.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]570 &quot;name&quot;: &quot;A String&quot;, # The [resource name](https://cloud.google.com/apis/design/resource_names) of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]571 # the looked-up `Membership`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]572 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]573 # Must be of the form `groups/{group_id}/memberships/{membership_id}`.
574 }</pre>
575</div>
576
577<div class="method">
578 <code class="details" id="modifyMembershipRoles">modifyMembershipRoles(name, body=None, x__xgafv=None)</code>
579 <pre>Modifies the `MembershipRole`s of a `Membership`.
580
581Args:
582 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of
583the `Membership` whose roles are to be modified.
584
585Must be of the form `groups/{group_id}/memberships/{membership_id}`. (required)
586 body: object, The request body.
587 The object takes the form of:
588
589{ # The request message for MembershipsService.ModifyMembershipRoles.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]590 &quot;updateRolesParams&quot;: [ # The `MembershipRole`s to be updated.
591 #
592 # Updating roles in the same request as adding or removing roles is not
593 # supported.
594 #
595 # Must not be set if either `add_roles` or `remove_roles` is set.
596 { # The details of an update to a `MembershipRole`.
597 &quot;fieldMask&quot;: &quot;A String&quot;, # The fully-qualified names of fields to update.
598 #
599 # May only contain the field `expiry_detail`.
600 &quot;membershipRole&quot;: { # A membership role within the Cloud Identity Groups API. # The `MembershipRole`s to be updated.
601 #
602 # Only `MEMBER` `MembershipRoles` can currently be updated.
603 #
604 # May only contain a `MembershipRole` with `name` `MEMBER`.
605 #
606 # A `MembershipRole` defines the privileges granted to a `Membership`.
607 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`.
608 #
609 # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
610 },
611 },
612 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]613 &quot;removeRoles&quot;: [ # The `name`s of the `MembershipRole`s to be removed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]614 #
615 # Adding or removing roles in the same request as updating roles is not
616 # supported.
617 #
618 # It is not possible to remove the `MEMBER` `MembershipRole`. If you wish to
619 # delete a `Membership`, call MembershipsService.DeleteMembership
620 # instead.
621 #
622 # Must not contain `MEMBER`. Must not be set if `update_roles_params` is set.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]623 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]624 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]625 &quot;addRoles&quot;: [ # The `MembershipRole`s to be added.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]626 #
627 # Adding or removing roles in the same request as updating roles is not
628 # supported.
629 #
630 # Must not be set if `update_roles_params` is set.
631 { # A membership role within the Cloud Identity Groups API.
632 #
633 # A `MembershipRole` defines the privileges granted to a `Membership`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]634 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]635 #
636 # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
637 },
638 ],
639 }
640
641 x__xgafv: string, V1 error format.
642 Allowed values
643 1 - v1 error format
644 2 - v2 error format
645
646Returns:
647 An object of the form:
648
649 { # The response message for MembershipsService.ModifyMembershipRoles.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]650 &quot;membership&quot;: { # A membership within the Cloud Identity Groups API. # The `Membership` resource after modifying its `MembershipRole`s.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]651 #
652 # A `Membership` defines a relationship between a `Group` and an entity
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]653 # belonging to that `Group`, referred to as a &quot;member&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]654 &quot;memberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Immutable. The `EntityKey` of the member.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]655 #
656 # Either `member_key` or `preferred_member_key` must be set when calling
657 # MembershipsService.CreateMembership but not both; both shall be set
658 # when returned.
659 #
660 # An entity can represent either a group with an optional `namespace` or a user
661 # without a `namespace`. The combination of `id` and `namespace` must be
662 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]663 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
664 #
665 # For Google-managed entities, the `id` must be the email address of an
666 # existing group or user.
667 #
668 # For external-identity-mapped entities, the `id` must be a string conforming
669 # to the Identity Source&#x27;s requirements.
670 #
671 # Must be unique within a `namespace`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]672 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
673 #
674 # If not specified, the `EntityKey` represents a Google-managed entity such
675 # as a Google user or a Google Group.
676 #
677 # If specified, the `EntityKey` represents an external-identity-mapped group.
678 # The namespace must correspond to an identity source created in Admin
679 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]680 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]681 &quot;preferredMemberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the member.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]682 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]683 # Either `member_key` or `preferred_member_key` must be set when calling
684 # MembershipsService.CreateMembership but not both; both shall be set
685 # when returned.
686 #
687 # An entity can represent either a group with an optional `namespace` or a user
688 # without a `namespace`. The combination of `id` and `namespace` must be
689 # unique; however, the same `id` can be used with different `namespace`s.
690 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
691 #
692 # For Google-managed entities, the `id` must be the email address of an
693 # existing group or user.
694 #
695 # For external-identity-mapped entities, the `id` must be a string conforming
696 # to the Identity Source&#x27;s requirements.
697 #
698 # Must be unique within a `namespace`.
699 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
700 #
701 # If not specified, the `EntityKey` represents a Google-managed entity such
702 # as a Google user or a Google Group.
703 #
704 # If specified, the `EntityKey` represents an external-identity-mapped group.
705 # The namespace must correspond to an identity source created in Admin
706 # Console and must be in the form of `identitysources/{identity_source_id}.
707 },
708 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
709 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]710 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]711 #
712 # If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`.
713 #
714 # Must not contain duplicate `MembershipRole`s with the same `name`.
715 { # A membership role within the Cloud Identity Groups API.
716 #
717 # A `MembershipRole` defines the privileges granted to a `Membership`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]718 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]719 #
720 # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
721 },
722 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]723 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
724 # the `Membership`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]725 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]726 # Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]727 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]728 }</pre>
729</div>
730
731</body></html>