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