blob: 6bd7db07858f654ff209529498c57f5b5a731a7f [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudidentity_v1.html">Cloud Identity API</a> . <a href="cloudidentity_v1.groups.html">groups</a> . <a href="cloudidentity_v1.groups.memberships.html">memberships</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Creates a Membership.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes a Membership.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Retrieves a Membership.</p>
89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070090 <code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070091<p class="firstline">Lists Memberships within a Group.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070096 <code><a href="#lookup">lookup(parent, memberKey_namespace=None, memberKey_id=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097<p class="firstline">Looks up [resource name](https://cloud.google.com/apis/design/resource_names) of a Membership within a Group by member's EntityKey.</p>
98<p class="toc_element">
99 <code><a href="#modifyMembershipRoles">modifyMembershipRoles(name, body=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Modifies the `MembershipRole`s of a `Membership`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700101<h3>Method Details</h3>
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700108 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109 <pre>Creates a Membership.
110
111Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700112 parent: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to create Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700113 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700114 The object takes the form of:
115
116{ # Resource representing a Membership within a Group
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700117 &quot;preferredMemberKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique. # Required. Immutable. EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`.
118 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is created corresponding to every Identity Source `identity_source_id`.
119 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique within its namespace.
120 },
121 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
122 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last updated timestamp of the Membership. Output only.
123 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp of the Membership. Output only.
124 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the format: `groups/{group_id}/memberships/{member_id}`, where group_id is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member Must be left blank while creating a Membership.
125 &quot;roles&quot;: [ # Roles for a member within the Group. Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
126 { # Resource representing a role within a Membership.
127 &quot;name&quot;: &quot;A String&quot;, # MembershipRole in string format. Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700128 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700129 ],
130}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700131
132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137Returns:
138 An object of the form:
139
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700140 { # This resource represents a long-running operation that is the result of a network API call.
141 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
142 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
143 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
144 },
145 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
146 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
147 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700148 {
149 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
150 },
151 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700152 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700153 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700154 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
155 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700156 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
157 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700158 }</pre>
159</div>
160
161<div class="method">
162 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
163 <pre>Deletes a Membership.
164
165Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700166 name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be deleted. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700167 x__xgafv: string, V1 error format.
168 Allowed values
169 1 - v1 error format
170 2 - v2 error format
171
172Returns:
173 An object of the form:
174
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700175 { # This resource represents a long-running operation that is the result of a network API call.
176 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
177 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
178 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
179 },
180 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
181 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
182 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700183 {
184 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
185 },
186 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700187 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700188 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700189 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
190 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700191 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
192 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700193 }</pre>
194</div>
195
196<div class="method">
197 <code class="details" id="get">get(name, x__xgafv=None)</code>
198 <pre>Retrieves a Membership.
199
200Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700201 name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be retrieved. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and `member_id` is the unique ID assigned to the member. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700202 x__xgafv: string, V1 error format.
203 Allowed values
204 1 - v1 error format
205 2 - v2 error format
206
207Returns:
208 An object of the form:
209
210 { # Resource representing a Membership within a Group
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700211 &quot;preferredMemberKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique. # Required. Immutable. EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`.
212 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is created corresponding to every Identity Source `identity_source_id`.
213 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique within its namespace.
214 },
215 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
216 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last updated timestamp of the Membership. Output only.
217 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp of the Membership. Output only.
218 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the format: `groups/{group_id}/memberships/{member_id}`, where group_id is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member Must be left blank while creating a Membership.
219 &quot;roles&quot;: [ # Roles for a member within the Group. Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
220 { # Resource representing a role within a Membership.
221 &quot;name&quot;: &quot;A String&quot;, # MembershipRole in string format. Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700222 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700223 ],
224 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700225</div>
226
227<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700228 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700229 <pre>Lists Memberships within a Group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700230
231Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700232 parent: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to list Memberships within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. (required)
233 pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700234 pageToken: string, The next_page_token value returned from a previous list request, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700235 view: string, Membership resource view to be returned. Defaults to View.BASIC.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700236 Allowed values
237 VIEW_UNSPECIFIED - Default. Should not be used.
238 BASIC - Server responses only include basic information.
239 FULL - Full representation of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700240 x__xgafv: string, V1 error format.
241 Allowed values
242 1 - v1 error format
243 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700244
245Returns:
246 An object of the form:
247
248 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700249 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results available for listing.
Bu Sun Kim65020912020-05-20 12:08:20 -0700250 &quot;memberships&quot;: [ # List of Memberships.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700251 { # Resource representing a Membership within a Group
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700252 &quot;preferredMemberKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique. # Required. Immutable. EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`.
253 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is created corresponding to every Identity Source `identity_source_id`.
254 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique within its namespace.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700255 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700256 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
257 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last updated timestamp of the Membership. Output only.
258 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp of the Membership. Output only.
259 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the format: `groups/{group_id}/memberships/{member_id}`, where group_id is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member Must be left blank while creating a Membership.
260 &quot;roles&quot;: [ # Roles for a member within the Group. Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
261 { # Resource representing a role within a Membership.
262 &quot;name&quot;: &quot;A String&quot;, # MembershipRole in string format. Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
263 },
264 ],
265 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700266 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700267 }</pre>
268</div>
269
270<div class="method">
271 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
272 <pre>Retrieves the next page of results.
273
274Args:
275 previous_request: The request for the previous page. (required)
276 previous_response: The response from the request for the previous page. (required)
277
278Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700279 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700280 page. Returns None if there are no more items in the collection.
281 </pre>
282</div>
283
284<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700285 <code class="details" id="lookup">lookup(parent, memberKey_namespace=None, memberKey_id=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700286 <pre>Looks up [resource name](https://cloud.google.com/apis/design/resource_names) of a Membership within a Group by member&#x27;s EntityKey.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700287
288Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700289 parent: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to lookup Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. (required)
290 memberKey_namespace: string, Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is created corresponding to every Identity Source `identity_source_id`.
291 memberKey_id: string, The ID of the entity within the given namespace. The ID must be unique within its namespace.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700292 x__xgafv: string, V1 error format.
293 Allowed values
294 1 - v1 error format
295 2 - v2 error format
296
297Returns:
298 An object of the form:
299
300 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700301 &quot;name&quot;: &quot;A String&quot;, # [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership being looked up. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique ID assigned to the Group to which Membership belongs to, and `member_id` is the unique ID assigned to the member.
302 }</pre>
303</div>
304
305<div class="method">
306 <code class="details" id="modifyMembershipRoles">modifyMembershipRoles(name, body=None, x__xgafv=None)</code>
307 <pre>Modifies the `MembershipRole`s of a `Membership`.
308
309Args:
310 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` whose roles are to be modified. Must be of the form `groups/{group_id}/memberships/{membership_id}`. (required)
311 body: object, The request body.
312 The object takes the form of:
313
314{ # The request message for MembershipsService.ModifyMembershipRoles.
315 &quot;addRoles&quot;: [ # The `MembershipRole`s to be added. Adding or removing roles in the same request as updating roles is not supported. Must not be set if `update_roles_params` is set.
316 { # Resource representing a role within a Membership.
317 &quot;name&quot;: &quot;A String&quot;, # MembershipRole in string format. Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
318 },
319 ],
320 &quot;removeRoles&quot;: [ # The `name`s of the `MembershipRole`s to be removed. Adding or removing roles in the same request as updating roles is not supported. It is not possible to remove the `MEMBER` `MembershipRole`. If you wish to delete a `Membership`, call MembershipsService.DeleteMembership instead. Must not contain `MEMBER`. Must not be set if `update_roles_params` is set.
321 &quot;A String&quot;,
322 ],
323 }
324
325 x__xgafv: string, V1 error format.
326 Allowed values
327 1 - v1 error format
328 2 - v2 error format
329
330Returns:
331 An object of the form:
332
333 { # The response message for MembershipsService.ModifyMembershipRoles.
334 &quot;membership&quot;: { # Resource representing a Membership within a Group # The `Membership` resource after modifying its `MembershipRole`s.
335 &quot;preferredMemberKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique. # Required. Immutable. EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`.
336 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is created corresponding to every Identity Source `identity_source_id`.
337 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique within its namespace.
338 },
339 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
340 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last updated timestamp of the Membership. Output only.
341 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp of the Membership. Output only.
342 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the format: `groups/{group_id}/memberships/{member_id}`, where group_id is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member Must be left blank while creating a Membership.
343 &quot;roles&quot;: [ # Roles for a member within the Group. Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
344 { # Resource representing a role within a Membership.
345 &quot;name&quot;: &quot;A String&quot;, # MembershipRole in string format. Currently supported MembershipRoles: `&quot;MEMBER&quot;`.
346 },
347 ],
348 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700349 }</pre>
350</div>
351
352</body></html>