Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / cloudidentity_v1beta1.groups.memberships.html
blob: ae414b819a4110bc81ca4b6edf7a825d09bf04fe [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">
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;.
114 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
115 &quot;preferredMemberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the member.
116 #
117 # Either `member_key` or `preferred_member_key` must be set when calling
118 # MembershipsService.CreateMembership but not both; both shall be set
119 # when returned.
120 #
121 # An entity can represent either a group with an optional `namespace` or a user
122 # without a `namespace`. The combination of `id` and `namespace` must be
123 # unique; however, the same `id` can be used with different `namespace`s.
124 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
125 #
126 # If not specified, the `EntityKey` represents a Google-managed entity such
127 # as a Google user or a Google Group.
128 #
129 # If specified, the `EntityKey` represents an external-identity-mapped group.
130 # The namespace must correspond to an identity source created in Admin
131 # Console and must be in the form of `identitysources/{identity_source_id}.
132 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
133 #
134 # For Google-managed entities, the `id` must be the email address of an
135 # existing group or user.
136 #
137 # For external-identity-mapped entities, the `id` must be a string conforming
138 # to the Identity Source&#x27;s requirements.
139 #
140 # Must be unique within a `namespace`.
141 },
142 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]143 # the `Membership`.
144 #
145 # Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]146 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]147 #
148 # If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`.
149 #
150 # Must not contain duplicate `MembershipRole`s with the same `name`.
151 { # A membership role within the Cloud Identity Groups API.
152 #
153 # A `MembershipRole` defines the privileges granted to a `Membership`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]154 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]156 # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]158 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159 &quot;memberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Immutable. The `EntityKey` of the member.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]160 #
161 # Either `member_key` or `preferred_member_key` must be set when calling
162 # MembershipsService.CreateMembership but not both; both shall be set
163 # when returned.
164 #
165 # An entity can represent either a group with an optional `namespace` or a user
166 # without a `namespace`. The combination of `id` and `namespace` must be
167 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]168 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]169 #
170 # If not specified, the `EntityKey` represents a Google-managed entity such
171 # as a Google user or a Google Group.
172 #
173 # If specified, the `EntityKey` represents an external-identity-mapped group.
174 # The namespace must correspond to an identity source created in Admin
175 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]177 #
178 # For Google-managed entities, the `id` must be the email address of an
179 # existing group or user.
180 #
181 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]183 #
184 # Must be unique within a `namespace`.
185 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]186 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]199 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
200 # If `true`, the operation is completed, and either `error` or `response` is
201 # available.
202 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
203 # originally returns it. If you use the default HTTP mapping, the
204 # `name` should be a resource name ending with `operations/{unique_id}`.
205 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
206 # contains progress information and common metadata such as create time.
207 # Some services might not provide such metadata. Any method that returns a
208 # long-running operation should document the metadata type, if any.
209 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
210 },
211 &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]212 # method returns no data on success, such as `Delete`, the response is
213 # `google.protobuf.Empty`. If the original method is standard
214 # `Get`/`Create`/`Update`, the response should be the resource. For other
215 # methods, the response should have the type `XxxResponse`, where `Xxx`
216 # is the original method name. For example, if the original method name
217 # is `TakeSnapshot()`, the inferred response type is
218 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]219 &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]220 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 # different programming environments, including REST APIs and RPC APIs. It is
223 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
224 # three pieces of data: error code, error message, and error details.
225 #
226 # You can find out more about this error model and how to work with it in the
227 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]228 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 # message types for APIs to use.
230 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]231 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232 },
233 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]234 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
235 # user-facing error message should be localized and sent in the
236 # google.rpc.Status.details field, or localized by the client.
237 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]238 },
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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]261 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
262 # If `true`, the operation is completed, and either `error` or `response` is
263 # available.
264 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
265 # originally returns it. If you use the default HTTP mapping, the
266 # `name` should be a resource name ending with `operations/{unique_id}`.
267 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
268 # contains progress information and common metadata such as create time.
269 # Some services might not provide such metadata. Any method that returns a
270 # long-running operation should document the metadata type, if any.
271 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
272 },
273 &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]274 # method returns no data on success, such as `Delete`, the response is
275 # `google.protobuf.Empty`. If the original method is standard
276 # `Get`/`Create`/`Update`, the response should be the resource. For other
277 # methods, the response should have the type `XxxResponse`, where `Xxx`
278 # is the original method name. For example, if the original method name
279 # is `TakeSnapshot()`, the inferred response type is
280 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]281 &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]282 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]283 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 # different programming environments, including REST APIs and RPC APIs. It is
285 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
286 # three pieces of data: error code, error message, and error details.
287 #
288 # You can find out more about this error model and how to work with it in the
289 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]290 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]291 # message types for APIs to use.
292 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]293 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]294 },
295 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]296 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
297 # user-facing error message should be localized and sent in the
298 # google.rpc.Status.details field, or localized by the client.
299 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]300 },
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;.
325 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
326 &quot;preferredMemberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the member.
327 #
328 # Either `member_key` or `preferred_member_key` must be set when calling
329 # MembershipsService.CreateMembership but not both; both shall be set
330 # when returned.
331 #
332 # An entity can represent either a group with an optional `namespace` or a user
333 # without a `namespace`. The combination of `id` and `namespace` must be
334 # unique; however, the same `id` can be used with different `namespace`s.
335 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
336 #
337 # If not specified, the `EntityKey` represents a Google-managed entity such
338 # as a Google user or a Google Group.
339 #
340 # If specified, the `EntityKey` represents an external-identity-mapped group.
341 # The namespace must correspond to an identity source created in Admin
342 # Console and must be in the form of `identitysources/{identity_source_id}.
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 },
353 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]354 # the `Membership`.
355 #
356 # Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]357 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]358 #
359 # If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`.
360 #
361 # Must not contain duplicate `MembershipRole`s with the same `name`.
362 { # A membership role within the Cloud Identity Groups API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]363 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]364 # A `MembershipRole` defines the privileges granted to a `Membership`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]365 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]366 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]367 # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]368 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]369 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]370 &quot;memberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Immutable. The `EntityKey` of the member.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]371 #
372 # Either `member_key` or `preferred_member_key` must be set when calling
373 # MembershipsService.CreateMembership but not both; both shall be set
374 # when returned.
375 #
376 # An entity can represent either a group with an optional `namespace` or a user
377 # without a `namespace`. The combination of `id` and `namespace` must be
378 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]379 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]380 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]381 # If not specified, the `EntityKey` represents a Google-managed entity such
382 # as a Google user or a Google Group.
383 #
384 # If specified, the `EntityKey` represents an external-identity-mapped group.
385 # The namespace must correspond to an identity source created in Admin
386 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]387 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]388 #
389 # For Google-managed entities, the `id` must be the email address of an
390 # existing group or user.
391 #
392 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]393 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]394 #
395 # Must be unique within a `namespace`.
396 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]397 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
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;nextPageToken&quot;: &quot;A String&quot;, # A continuation token to retrieve the next page of results, or empty if
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]436 # there are no more results available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]437 &quot;memberships&quot;: [ # The `Membership`s under the specified `parent`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]438 { # A membership within the Cloud Identity Groups API.
439 #
440 # A `Membership` defines a relationship between a `Group` and an entity
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]441 # belonging to that `Group`, referred to as a &quot;member&quot;.
442 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
443 &quot;preferredMemberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the member.
444 #
445 # Either `member_key` or `preferred_member_key` must be set when calling
446 # MembershipsService.CreateMembership but not both; both shall be set
447 # when returned.
448 #
449 # An entity can represent either a group with an optional `namespace` or a user
450 # without a `namespace`. The combination of `id` and `namespace` must be
451 # unique; however, the same `id` can be used with different `namespace`s.
452 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
453 #
454 # If not specified, the `EntityKey` represents a Google-managed entity such
455 # as a Google user or a Google Group.
456 #
457 # If specified, the `EntityKey` represents an external-identity-mapped group.
458 # The namespace must correspond to an identity source created in Admin
459 # Console and must be in the form of `identitysources/{identity_source_id}.
460 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
461 #
462 # For Google-managed entities, the `id` must be the email address of an
463 # existing group or user.
464 #
465 # For external-identity-mapped entities, the `id` must be a string conforming
466 # to the Identity Source&#x27;s requirements.
467 #
468 # Must be unique within a `namespace`.
469 },
470 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]471 # the `Membership`.
472 #
473 # Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]474 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]475 #
476 # If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`.
477 #
478 # Must not contain duplicate `MembershipRole`s with the same `name`.
479 { # A membership role within the Cloud Identity Groups API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]480 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]481 # A `MembershipRole` defines the privileges granted to a `Membership`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]482 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]483 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]484 # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]485 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]486 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]487 &quot;memberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Immutable. The `EntityKey` of the member.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]488 #
489 # Either `member_key` or `preferred_member_key` must be set when calling
490 # MembershipsService.CreateMembership but not both; both shall be set
491 # when returned.
492 #
493 # An entity can represent either a group with an optional `namespace` or a user
494 # without a `namespace`. The combination of `id` and `namespace` must be
495 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]496 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]497 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]498 # If not specified, the `EntityKey` represents a Google-managed entity such
499 # as a Google user or a Google Group.
500 #
501 # If specified, the `EntityKey` represents an external-identity-mapped group.
502 # The namespace must correspond to an identity source created in Admin
503 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]504 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]505 #
506 # For Google-managed entities, the `id` must be the email address of an
507 # existing group or user.
508 #
509 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]510 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]511 #
512 # Must be unique within a `namespace`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]513 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]514 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]515 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]516 ],
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">
535 <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]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)
544 memberKey_namespace: string, The namespace in which the entity exists.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]545
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]546If not specified, the `EntityKey` represents a Google-managed entity such
547as a Google user or a Google Group.
548
549If specified, the `EntityKey` represents an external-identity-mapped group.
550The namespace must correspond to an identity source created in Admin
551Console and must be in the form of `identitysources/{identity_source_id}.
552 memberKey_id: string, The ID of the entity.
553
554For Google-managed entities, the `id` must be the email address of an
555existing group or user.
556
557For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]558to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]559
560Must be unique within a `namespace`.
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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]590 &quot;removeRoles&quot;: [ # The `name`s of the `MembershipRole`s to be removed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]591 #
592 # Adding or removing roles in the same request as updating roles is not
593 # supported.
594 #
595 # It is not possible to remove the `MEMBER` `MembershipRole`. If you wish to
596 # delete a `Membership`, call MembershipsService.DeleteMembership
597 # instead.
598 #
599 # 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]600 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]601 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]602 &quot;addRoles&quot;: [ # The `MembershipRole`s to be added.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]603 #
604 # Adding or removing roles in the same request as updating roles is not
605 # supported.
606 #
607 # Must not be set if `update_roles_params` is set.
608 { # A membership role within the Cloud Identity Groups API.
609 #
610 # A `MembershipRole` defines the privileges granted to a `Membership`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]611 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]612 #
613 # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
614 },
615 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]616 &quot;updateRolesParams&quot;: [ # The `MembershipRole`s to be updated.
617 #
618 # Updating roles in the same request as adding or removing roles is not
619 # supported.
620 #
621 # Must not be set if either `add_roles` or `remove_roles` is set.
622 { # The details of an update to a `MembershipRole`.
623 &quot;fieldMask&quot;: &quot;A String&quot;, # The fully-qualified names of fields to update.
624 #
625 # May only contain the field `expiry_detail`.
626 &quot;membershipRole&quot;: { # A membership role within the Cloud Identity Groups API. # The `MembershipRole`s to be updated.
627 #
628 # Only `MEMBER` `MembershipRoles` can currently be updated.
629 #
630 # May only contain a `MembershipRole` with `name` `MEMBER`.
631 #
632 # A `MembershipRole` defines the privileges granted to a `Membership`.
633 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`.
634 #
635 # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
636 },
637 },
638 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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;.
654 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
655 &quot;preferredMemberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the member.
656 #
657 # Either `member_key` or `preferred_member_key` must be set when calling
658 # MembershipsService.CreateMembership but not both; both shall be set
659 # when returned.
660 #
661 # An entity can represent either a group with an optional `namespace` or a user
662 # without a `namespace`. The combination of `id` and `namespace` must be
663 # unique; however, the same `id` can be used with different `namespace`s.
664 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
665 #
666 # If not specified, the `EntityKey` represents a Google-managed entity such
667 # as a Google user or a Google Group.
668 #
669 # If specified, the `EntityKey` represents an external-identity-mapped group.
670 # The namespace must correspond to an identity source created in Admin
671 # Console and must be in the form of `identitysources/{identity_source_id}.
672 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
673 #
674 # For Google-managed entities, the `id` must be the email address of an
675 # existing group or user.
676 #
677 # For external-identity-mapped entities, the `id` must be a string conforming
678 # to the Identity Source&#x27;s requirements.
679 #
680 # Must be unique within a `namespace`.
681 },
682 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]683 # the `Membership`.
684 #
685 # Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]686 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]687 #
688 # If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`.
689 #
690 # Must not contain duplicate `MembershipRole`s with the same `name`.
691 { # A membership role within the Cloud Identity Groups API.
692 #
693 # A `MembershipRole` defines the privileges granted to a `Membership`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]694 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]695 #
696 # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
697 },
698 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]699 &quot;memberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Immutable. The `EntityKey` of the member.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]700 #
701 # Either `member_key` or `preferred_member_key` must be set when calling
702 # MembershipsService.CreateMembership but not both; both shall be set
703 # when returned.
704 #
705 # An entity can represent either a group with an optional `namespace` or a user
706 # without a `namespace`. The combination of `id` and `namespace` must be
707 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]708 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]709 #
710 # If not specified, the `EntityKey` represents a Google-managed entity such
711 # as a Google user or a Google Group.
712 #
713 # If specified, the `EntityKey` represents an external-identity-mapped group.
714 # The namespace must correspond to an identity source created in Admin
715 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]716 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]717 #
718 # For Google-managed entities, the `id` must be the email address of an
719 # existing group or user.
720 #
721 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]722 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]723 #
724 # Must be unique within a `namespace`.
725 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]726 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
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>