Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / cloudidentity_v1beta1.groups.memberships.html
blob: b756a0c31a2bc50590029d947fa756984ae0bd2f [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#checkTransitiveMembership">checkTransitiveMembership(parent, query=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]79<p class="firstline">Check a potential member for membership in a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]84 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Creates a `Membership`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]88<p class="firstline">Deletes a `Membership`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]91<p class="firstline">Retrieves a `Membership`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]93 <code><a href="#getMembershipGraph">getMembershipGraph(parent, query=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]94<p class="firstline">Get a membership graph of just a member or both a member and a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the response will contain all membership paths between the group and the member.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]95<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]96 <code><a href="#list">list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97<p class="firstline">Lists the `Membership`s within a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]102 <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 -0700[diff] [blame]103<p class="firstline">Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104<p class="toc_element">
105 <code><a href="#modifyMembershipRoles">modifyMembershipRoles(name, body=None, x__xgafv=None)</a></code></p>
106<p class="firstline">Modifies the `MembershipRole`s of a `Membership`.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]108 <code><a href="#searchTransitiveGroups">searchTransitiveGroups(parent, pageToken=None, query=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]109<p class="firstline">Search transitive groups of a member. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]110<p class="toc_element">
111 <code><a href="#searchTransitiveGroups_next">searchTransitiveGroups_next(previous_request, previous_response)</a></code></p>
112<p class="firstline">Retrieves the next page of results.</p>
113<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]114 <code><a href="#searchTransitiveMemberships">searchTransitiveMemberships(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
115<p class="firstline">Search transitive memberships of a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]116<p class="toc_element">
117 <code><a href="#searchTransitiveMemberships_next">searchTransitiveMemberships_next(previous_request, previous_response)</a></code></p>
118<p class="firstline">Retrieves the next page of results.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119<h3>Method Details</h3>
120<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]121 <code class="details" id="checkTransitiveMembership">checkTransitiveMembership(parent, query=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]122 <pre>Check a potential member for membership in a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]123
124Args:
125 parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to check the transitive membership in. Format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group to which the Membership belongs to. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]126 query: string, Required. A CEL expression that MUST include member specification. This is a `required` field. Certain groups are uniquely identified by both a &#x27;member_key_id&#x27; and a &#x27;member_key_namespace&#x27;, which requires an additional query input: &#x27;member_key_namespace&#x27;. Example query: `member_key_id == &#x27;member_key_id_value&#x27;`
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
131
132Returns:
133 An object of the form:
134
135 { # The response message for MembershipsService.CheckTransitiveMembership.
136 &quot;hasMembership&quot;: True or False, # Response does not include the possible roles of a member since the behavior of this rpc is not all-or-nothing unlike the other rpcs. So, it may not be possible to list all the roles definitively, due to possible lack of authorization in some of the paths.
137 }</pre>
138</div>
139
140<div class="method">
141 <code class="details" id="close">close()</code>
142 <pre>Close httplib2 connections.</pre>
143</div>
144
145<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]146 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
147 <pre>Creates a `Membership`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148
149Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]150 parent: string, Required. The parent `Group` resource under which to create the `Membership`. Must be of the form `groups/{group_id}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]151 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152 The object takes the form of:
153
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]154{ # A membership within the Cloud Identity Groups API. A `Membership` defines a relationship between a `Group` and an entity belonging to that `Group`, referred to as a &quot;member&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]155 &quot;preferredMemberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the member. Either `member_key` or `preferred_member_key` must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]156 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]157 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]158 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]159 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
160 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]161 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]162 &quot;memberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Immutable. The `EntityKey` of the member. Either `member_key` or `preferred_member_key` must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
163 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
164 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
165 },
166 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]167 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`.
168 { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]169 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]170 &quot;expiryDetail&quot;: { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value.
171 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
172 },
173 },
174 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]175 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176
177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
181
182Returns:
183 An object of the form:
184
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]185 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]186 &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.
187 &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}`.
188 &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.
189 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
190 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]191 &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.
192 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]193 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]194 &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 Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]195 {
196 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
197 },
198 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]199 },
200 &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`.
201 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]202 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]203 }</pre>
204</div>
205
206<div class="method">
207 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]208 <pre>Deletes a `Membership`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]209
210Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]211 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to delete. Must be of the form `groups/{group_id}/memberships/{membership_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212 x__xgafv: string, V1 error format.
213 Allowed values
214 1 - v1 error format
215 2 - v2 error format
216
217Returns:
218 An object of the form:
219
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]220 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]221 &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.
222 &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}`.
223 &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.
224 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
225 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]226 &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.
227 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]228 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]229 &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 Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]230 {
231 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
232 },
233 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]234 },
235 &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`.
236 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]237 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]238 }</pre>
239</div>
240
241<div class="method">
242 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]243 <pre>Retrieves a `Membership`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244
245Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]246 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to retrieve. Must be of the form `groups/{group_id}/memberships/{membership_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]247 x__xgafv: string, V1 error format.
248 Allowed values
249 1 - v1 error format
250 2 - v2 error format
251
252Returns:
253 An object of the form:
254
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]255 { # A membership within the Cloud Identity Groups API. A `Membership` defines a relationship between a `Group` and an entity belonging to that `Group`, referred to as a &quot;member&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]256 &quot;preferredMemberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the member. Either `member_key` or `preferred_member_key` must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]257 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]258 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]259 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]260 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
261 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]262 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]263 &quot;memberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Immutable. The `EntityKey` of the member. Either `member_key` or `preferred_member_key` must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
264 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
265 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
266 },
267 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]268 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`.
269 { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]270 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]271 &quot;expiryDetail&quot;: { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value.
272 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
273 },
274 },
275 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]276 }</pre>
277</div>
278
279<div class="method">
280 <code class="details" id="getMembershipGraph">getMembershipGraph(parent, query=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]281 <pre>Get a membership graph of just a member or both a member and a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the response will contain all membership paths between the group and the member.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]282
283Args:
284 parent: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group to which the Membership belongs to. group_id can be a wildcard collection id &quot;-&quot;. When a group_id is specified, the membership graph will be constrained to paths between the member (defined in the query) and the parent. If a wildcard collection is provided, all membership paths connected to the member will be returned. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]285 query: string, Required. A CEL expression that MUST include member specification AND label(s). Certain groups are uniquely identified by both a &#x27;member_key_id&#x27; and a &#x27;member_key_namespace&#x27;, which requires an additional query input: &#x27;member_key_namespace&#x27;. Example query: `member_key_id == &#x27;member_key_id_value&#x27; &amp;&amp; in labels`
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]286 x__xgafv: string, V1 error format.
287 Allowed values
288 1 - v1 error format
289 2 - v2 error format
290
291Returns:
292 An object of the form:
293
294 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]295 &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.
296 &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}`.
297 &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.
298 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
299 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]300 &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.
301 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]302 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]303 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
304 {
305 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
306 },
307 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]308 },
309 &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`.
310 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]311 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]312 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]313</div>
314
315<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]316 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]317 <pre>Lists the `Membership`s within a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]318
319Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]320 parent: string, Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]321 pageToken: string, The `next_page_token` value returned from a previous search request, if any.
322 pageSize: integer, The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]323 view: string, The level of detail to be returned. If unspecified, defaults to `MembershipView.BASIC`.
324 Allowed values
325 BASIC - Default. Only basic resource information is returned.
326 FULL - All resource information is returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]327 x__xgafv: string, V1 error format.
328 Allowed values
329 1 - v1 error format
330 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]331
332Returns:
333 An object of the form:
334
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]335 { # The response message for MembershipsService.ListMemberships.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]336 &quot;memberships&quot;: [ # The `Membership`s under the specified `parent`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]337 { # A membership within the Cloud Identity Groups API. A `Membership` defines a relationship between a `Group` and an entity belonging to that `Group`, referred to as a &quot;member&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]338 &quot;preferredMemberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the member. Either `member_key` or `preferred_member_key` must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]339 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]340 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]341 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]342 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
343 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]344 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]345 &quot;memberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Immutable. The `EntityKey` of the member. Either `member_key` or `preferred_member_key` must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
346 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
347 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
348 },
349 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]350 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`.
351 { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]352 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]353 &quot;expiryDetail&quot;: { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value.
354 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
355 },
356 },
357 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]358 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]360 &quot;nextPageToken&quot;: &quot;A String&quot;, # A continuation token to retrieve the next page of results, or empty if there are no more results available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]361 }</pre>
362</div>
363
364<div class="method">
365 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
366 <pre>Retrieves the next page of results.
367
368Args:
369 previous_request: The request for the previous page. (required)
370 previous_response: The response from the request for the previous page. (required)
371
372Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]373 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]374 page. Returns None if there are no more items in the collection.
375 </pre>
376</div>
377
378<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]379 <code class="details" id="lookup">lookup(parent, memberKey_namespace=None, memberKey_id=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]380 <pre>Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]381
382Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]383 parent: string, Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. (required)
384 memberKey_namespace: string, The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
385 memberKey_id: string, The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386 x__xgafv: string, V1 error format.
387 Allowed values
388 1 - v1 error format
389 2 - v2 error format
390
391Returns:
392 An object of the form:
393
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]394 { # The response message for MembershipsService.LookupMembershipName.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]395 &quot;name&quot;: &quot;A String&quot;, # The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Membership`. Must be of the form `groups/{group_id}/memberships/{membership_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]396 }</pre>
397</div>
398
399<div class="method">
400 <code class="details" id="modifyMembershipRoles">modifyMembershipRoles(name, body=None, x__xgafv=None)</code>
401 <pre>Modifies the `MembershipRole`s of a `Membership`.
402
403Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]404 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]405 body: object, The request body.
406 The object takes the form of:
407
408{ # The request message for MembershipsService.ModifyMembershipRoles.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]409 &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.
410 { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]411 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]412 &quot;expiryDetail&quot;: { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]413 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
414 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]415 },
416 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]417 &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.
418 &quot;A String&quot;,
419 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]420 &quot;updateRolesParams&quot;: [ # The `MembershipRole`s to be updated. Updating roles in the same request as adding or removing roles is not supported. Must not be set if either `add_roles` or `remove_roles` is set.
421 { # The details of an update to a `MembershipRole`.
422 &quot;membershipRole&quot;: { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`. # The `MembershipRole`s to be updated. Only `MEMBER` `MembershipRoles` can currently be updated. May only contain a `MembershipRole` with `name` `MEMBER`.
423 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
424 &quot;expiryDetail&quot;: { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value.
425 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
426 },
427 },
428 &quot;fieldMask&quot;: &quot;A String&quot;, # The fully-qualified names of fields to update. May only contain the field `expiry_detail`.
429 },
430 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]431 }
432
433 x__xgafv: string, V1 error format.
434 Allowed values
435 1 - v1 error format
436 2 - v2 error format
437
438Returns:
439 An object of the form:
440
441 { # The response message for MembershipsService.ModifyMembershipRoles.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]442 &quot;membership&quot;: { # A membership within the Cloud Identity Groups API. A `Membership` defines a relationship between a `Group` and an entity belonging to that `Group`, referred to as a &quot;member&quot;. # The `Membership` resource after modifying its `MembershipRole`s.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]443 &quot;preferredMemberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the member. Either `member_key` or `preferred_member_key` must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]444 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]445 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]446 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]447 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
448 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]449 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]450 &quot;memberKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Immutable. The `EntityKey` of the member. Either `member_key` or `preferred_member_key` must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
451 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
452 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
453 },
454 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]455 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`.
456 { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]457 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]458 &quot;expiryDetail&quot;: { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value.
459 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
460 },
461 },
462 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]463 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]464 }</pre>
465</div>
466
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]467<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]468 <code class="details" id="searchTransitiveGroups">searchTransitiveGroups(parent, pageToken=None, query=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]469 <pre>Search transitive groups of a member. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]470
471Args:
472 parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is always &#x27;-&#x27; as this API will search across all groups for a given member. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]473 pageToken: string, The next_page_token value returned from a previous list request, if any.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]474 query: string, Required. A CEL expression that MUST include member specification AND label(s). This is a `required` field. Users can search on label attributes of groups. CONTAINS match (&#x27;in&#x27;) is supported on labels. Certain groups are uniquely identified by both a &#x27;member_key_id&#x27; and a &#x27;member_key_namespace&#x27;, which requires an additional query input: &#x27;member_key_namespace&#x27;. Example query: `member_key_id == &#x27;member_key_id_value&#x27; &amp;&amp; in labels`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]475 pageSize: integer, The default page size is 200 (max 1000).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]476 x__xgafv: string, V1 error format.
477 Allowed values
478 1 - v1 error format
479 2 - v2 error format
480
481Returns:
482 An object of the form:
483
484 { # The response message for MembershipsService.SearchTransitiveGroups.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]485 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]486 &quot;memberships&quot;: [ # List of transitive groups satisfying the query.
487 { # Message representing a transitive group of a user or a group.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]488 &quot;relationType&quot;: &quot;A String&quot;, # The relation between the member and the transitive group.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]489 &quot;roles&quot;: [ # Membership roles of the member for the group.
490 { # Message representing the role of a TransitiveMembership.
491 &quot;role&quot;: &quot;A String&quot;, # TransitiveMembershipRole in string format. Currently supported TransitiveMembershipRoles: `&quot;MEMBER&quot;`, `&quot;OWNER&quot;`, and `&quot;MANAGER&quot;`.
492 },
493 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]494 &quot;group&quot;: &quot;A String&quot;, # Resource name for this group.
495 &quot;displayName&quot;: &quot;A String&quot;, # Display name for this group.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]496 &quot;labels&quot;: { # Labels for Group resource.
497 &quot;a_key&quot;: &quot;A String&quot;,
498 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]499 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Entity key has an id and a namespace. In case of discussion forums, the id will be an email address without a namespace.
500 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
501 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
502 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]503 },
504 ],
505 }</pre>
506</div>
507
508<div class="method">
509 <code class="details" id="searchTransitiveGroups_next">searchTransitiveGroups_next(previous_request, previous_response)</code>
510 <pre>Retrieves the next page of results.
511
512Args:
513 previous_request: The request for the previous page. (required)
514 previous_response: The response from the request for the previous page. (required)
515
516Returns:
517 A request object that you can call &#x27;execute()&#x27; on to request the next
518 page. Returns None if there are no more items in the collection.
519 </pre>
520</div>
521
522<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]523 <code class="details" id="searchTransitiveMemberships">searchTransitiveMemberships(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
524 <pre>Search transitive memberships of a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]525
526Args:
527 parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]528 pageSize: integer, The default page size is 200 (max 1000).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]529 pageToken: string, The next_page_token value returned from a previous list request, if any.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]530 x__xgafv: string, V1 error format.
531 Allowed values
532 1 - v1 error format
533 2 - v2 error format
534
535Returns:
536 An object of the form:
537
538 { # The response message for MembershipsService.SearchTransitiveMemberships.
539 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results.
540 &quot;memberships&quot;: [ # List of transitive members satisfying the query.
541 { # Message representing a transitive membership of a group.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]542 &quot;relationType&quot;: &quot;A String&quot;, # The relation between the group and the transitive member.
543 &quot;roles&quot;: [ # The membership role details (i.e name of role and expiry time).
544 { # Message representing the role of a TransitiveMembership.
545 &quot;role&quot;: &quot;A String&quot;, # TransitiveMembershipRole in string format. Currently supported TransitiveMembershipRoles: `&quot;MEMBER&quot;`, `&quot;OWNER&quot;`, and `&quot;MANAGER&quot;`.
546 },
547 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]548 &quot;preferredMemberKey&quot;: [ # Entity key has an id and a namespace. In case of discussion forums, the id will be an email address without a namespace.
549 { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s.
550 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
551 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
552 },
553 ],
554 &quot;member&quot;: &quot;A String&quot;, # Resource name for this member if member is a GROUP, otherwise it is empty.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]555 },
556 ],
557 }</pre>
558</div>
559
560<div class="method">
561 <code class="details" id="searchTransitiveMemberships_next">searchTransitiveMemberships_next(previous_request, previous_response)</code>
562 <pre>Retrieves the next page of results.
563
564Args:
565 previous_request: The request for the previous page. (required)
566 previous_response: The response from the request for the previous page. (required)
567
568Returns:
569 A request object that you can call &#x27;execute()&#x27; on to request the next
570 page. Returns None if there are no more items in the collection.
571 </pre>
572</div>
573
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]574</body></html>