Blame - docs/dyn/cloudidentity_v1beta1.groups.memberships.html - platform/external/python/google-api-python-client

blob: 9c3c7f03c61f39c2920fcddee7092ac8f4e700fc [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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 Frenkel	3e17f89	2020-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 Kim	673ec5c	2020-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 Frenkel	3e17f89	2020-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'Meara	dd49464	2020-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 Kim	715bd7f	2019-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'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	88	<p class="firstline">Deletes a `Membership`.</p>
Bu Sun Kim	715bd7f	2019-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'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	91	<p class="firstline">Retrieves a `Membership`.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	92	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-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 Kim	673ec5c	2020-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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	95	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	96	<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	97	<p class="firstline">Lists the `Membership`s within a `Group`.</p>
Bu Sun Kim	715bd7f	2019-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">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	102	<code><a href="#lookup">lookup(parent, memberKey_id=None, memberKey_namespace=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-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'Meara	dd49464	2020-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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	107	<p class="toc_element">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	108	<code><a href="#searchTransitiveGroups">searchTransitiveGroups(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-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 Frenkel	3e17f89	2020-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">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	114	<code><a href="#searchTransitiveMemberships">searchTransitiveMemberships(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	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 Frenkel	3e17f89	2020-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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	119	<h3>Method Details</h3>
				120	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	121	<code class="details" id="checkTransitiveMembership">checkTransitiveMembership(parent, query=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	123
				124	Args:
				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 Kim	673ec5c	2020-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 'member_key_id' and a 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query: `member_key_id == 'member_key_id_value'`
Dmitry Frenkel	3e17f89	2020-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
				132	Returns:
				133	An object of the form:
				134
				135	{ # The response message for MembershipsService.CheckTransitiveMembership.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	136	"hasMembership": 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>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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'Meara	dd49464	2020-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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	148
				149	Args:
Dmitry Frenkel	3e17f89	2020-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'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	151	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	152	The object takes the form of:
				153
Dmitry Frenkel	3e17f89	2020-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 "member".
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	155	"createTime": "A String", # Output only. The time when the `Membership` was created.
				156	"memberKey": { # 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.
				157	"id": "A 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's requirements. Must be unique within a `namespace`.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	158	"namespace": "A 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}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	159	},
				160	"name": "A String", # 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}`.
				161	"preferredMemberKey": { # 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.
				162	"id": "A 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's requirements. Must be unique within a `namespace`.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	163	"namespace": "A 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}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	164	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	165	"roles": [ # 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`.
				166	{ # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	167	"expiryDetail": { # 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.
				168	"expireTime": "A String", # The time at which the `MembershipRole` will expire.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	169	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	170	"name": "A String", # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
yoshi-code-bot	9d63883	2021-10-05 00:20:14 -0700	[diff] [blame]	171	"restrictionEvaluations": { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership.
				172	"memberRestrictionEvaluation": { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
				173	"state": "A String", # Output only. The current state of the restriction
				174	},
				175	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	176	},
				177	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	178	"type": "A String", # Output only. The type of the membership.
				179	"updateTime": "A String", # Output only. The time when the `Membership` was last updated.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	180	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	181
				182	x__xgafv: string, V1 error format.
				183	Allowed values
				184	1 - v1 error format
				185	2 - v2 error format
				186
				187	Returns:
				188	An object of the form:
				189
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	190	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	191	"done": 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.
				192	"error": { # 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.
				193	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				194	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				195	{
				196	"a_key": "", # Properties of the object. Contains field @type with type URL.
				197	},
				198	],
				199	"message": "A String", # 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.
				200	},
				201	"metadata": { # 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.
				202	"a_key": "", # Properties of the object. Contains field @type with type URL.
				203	},
				204	"name": "A String", # 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}`.
				205	"response": { # 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`.
				206	"a_key": "", # Properties of the object. Contains field @type with type URL.
				207	},
				208	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	209	</div>
				210
				211	<div class="method">
				212	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	213	<pre>Deletes a `Membership`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	214
				215	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	216	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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	217	x__xgafv: string, V1 error format.
				218	Allowed values
				219	1 - v1 error format
				220	2 - v2 error format
				221
				222	Returns:
				223	An object of the form:
				224
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	225	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	226	"done": 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.
				227	"error": { # 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.
				228	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				229	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				230	{
				231	"a_key": "", # Properties of the object. Contains field @type with type URL.
				232	},
				233	],
				234	"message": "A String", # 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.
				235	},
				236	"metadata": { # 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.
				237	"a_key": "", # Properties of the object. Contains field @type with type URL.
				238	},
				239	"name": "A String", # 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}`.
				240	"response": { # 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`.
				241	"a_key": "", # Properties of the object. Contains field @type with type URL.
				242	},
				243	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	244	</div>
				245
				246	<div class="method">
				247	<code class="details" id="get">get(name, x__xgafv=None)</code>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	248	<pre>Retrieves a `Membership`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	249
				250	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	251	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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	252	x__xgafv: string, V1 error format.
				253	Allowed values
				254	1 - v1 error format
				255	2 - v2 error format
				256
				257	Returns:
				258	An object of the form:
				259
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	260	{ # 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 "member".
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	261	"createTime": "A String", # Output only. The time when the `Membership` was created.
				262	"memberKey": { # 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.
				263	"id": "A 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's requirements. Must be unique within a `namespace`.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	264	"namespace": "A 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}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	265	},
				266	"name": "A String", # 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}`.
				267	"preferredMemberKey": { # 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.
				268	"id": "A 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's requirements. Must be unique within a `namespace`.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	269	"namespace": "A 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}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	270	},
				271	"roles": [ # 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`.
				272	{ # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
				273	"expiryDetail": { # 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.
				274	"expireTime": "A String", # The time at which the `MembershipRole` will expire.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	275	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	276	"name": "A String", # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
yoshi-code-bot	9d63883	2021-10-05 00:20:14 -0700	[diff] [blame]	277	"restrictionEvaluations": { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership.
				278	"memberRestrictionEvaluation": { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
				279	"state": "A String", # Output only. The current state of the restriction
				280	},
				281	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	282	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	283	],
				284	"type": "A String", # Output only. The type of the membership.
				285	"updateTime": "A String", # Output only. The time when the `Membership` was last updated.
				286	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	287	</div>
				288
				289	<div class="method">
				290	<code class="details" id="getMembershipGraph">getMembershipGraph(parent, query=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	291	<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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	292
				293	Args:
				294	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 "-". 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 Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	295	query: string, Required. A CEL expression that MUST include member specification AND label(s). Certain groups are uniquely identified by both a 'member_key_id' and a 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query: `member_key_id == 'member_key_id_value' && in labels`
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	296	x__xgafv: string, V1 error format.
				297	Allowed values
				298	1 - v1 error format
				299	2 - v2 error format
				300
				301	Returns:
				302	An object of the form:
				303
				304	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	305	"done": 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.
				306	"error": { # 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.
				307	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				308	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				309	{
				310	"a_key": "", # Properties of the object. Contains field @type with type URL.
				311	},
				312	],
				313	"message": "A String", # 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.
				314	},
				315	"metadata": { # 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.
				316	"a_key": "", # Properties of the object. Contains field @type with type URL.
				317	},
				318	"name": "A String", # 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}`.
				319	"response": { # 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`.
				320	"a_key": "", # Properties of the object. Contains field @type with type URL.
				321	},
				322	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	323	</div>
				324
				325	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	326	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	327	<pre>Lists the `Membership`s within a `Group`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	328
				329	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	330	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 Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	331	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`.
				332	pageToken: string, The `next_page_token` value returned from a previous search request, if any.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	333	view: string, The level of detail to be returned. If unspecified, defaults to `MembershipView.BASIC`.
				334	Allowed values
				335	BASIC - Default. Only basic resource information is returned.
				336	FULL - All resource information is returned.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	337	x__xgafv: string, V1 error format.
				338	Allowed values
				339	1 - v1 error format
				340	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	341
				342	Returns:
				343	An object of the form:
				344
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	345	{ # The response message for MembershipsService.ListMemberships.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	346	"memberships": [ # The `Membership`s under the specified `parent`.
				347	{ # 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 "member".
				348	"createTime": "A String", # Output only. The time when the `Membership` was created.
				349	"memberKey": { # 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.
				350	"id": "A 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's requirements. Must be unique within a `namespace`.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	351	"namespace": "A 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}`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	352	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	353	"name": "A String", # 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}`.
				354	"preferredMemberKey": { # 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.
				355	"id": "A 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's requirements. Must be unique within a `namespace`.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	356	"namespace": "A 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}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	357	},
				358	"roles": [ # 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`.
				359	{ # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
				360	"expiryDetail": { # 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.
				361	"expireTime": "A String", # The time at which the `MembershipRole` will expire.
				362	},
				363	"name": "A String", # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
yoshi-code-bot	9d63883	2021-10-05 00:20:14 -0700	[diff] [blame]	364	"restrictionEvaluations": { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership.
				365	"memberRestrictionEvaluation": { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
				366	"state": "A String", # Output only. The current state of the restriction
				367	},
				368	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	369	},
				370	],
				371	"type": "A String", # Output only. The type of the membership.
				372	"updateTime": "A String", # Output only. The time when the `Membership` was last updated.
				373	},
				374	],
				375	"nextPageToken": "A String", # A continuation token to retrieve the next page of results, or empty if there are no more results available.
				376	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	377	</div>
				378
				379	<div class="method">
				380	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				381	<pre>Retrieves the next page of results.
				382
				383	Args:
				384	previous_request: The request for the previous page. (required)
				385	previous_response: The response from the request for the previous page. (required)
				386
				387	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	388	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	389	page. Returns None if there are no more items in the collection.
				390	</pre>
				391	</div>
				392
				393	<div class="method">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	394	<code class="details" id="lookup">lookup(parent, memberKey_id=None, memberKey_namespace=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	395	<pre>Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	396
				397	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	398	parent: string, Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	399	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's requirements. Must be unique within a `namespace`.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	400	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}`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	401	x__xgafv: string, V1 error format.
				402	Allowed values
				403	1 - v1 error format
				404	2 - v2 error format
				405
				406	Returns:
				407	An object of the form:
				408
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	409	{ # The response message for MembershipsService.LookupMembershipName.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	410	"name": "A String", # 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}`.
				411	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	412	</div>
				413
				414	<div class="method">
				415	<code class="details" id="modifyMembershipRoles">modifyMembershipRoles(name, body=None, x__xgafv=None)</code>
				416	<pre>Modifies the `MembershipRole`s of a `Membership`.
				417
				418	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	419	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'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	420	body: object, The request body.
				421	The object takes the form of:
				422
				423	{ # The request message for MembershipsService.ModifyMembershipRoles.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	424	"addRoles": [ # 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.
				425	{ # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
				426	"expiryDetail": { # 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.
				427	"expireTime": "A String", # The time at which the `MembershipRole` will expire.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	428	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	429	"name": "A String", # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
yoshi-code-bot	9d63883	2021-10-05 00:20:14 -0700	[diff] [blame]	430	"restrictionEvaluations": { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership.
				431	"memberRestrictionEvaluation": { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
				432	"state": "A String", # Output only. The current state of the restriction
				433	},
				434	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	435	},
				436	],
				437	"removeRoles": [ # 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.
				438	"A String",
				439	],
				440	"updateRolesParams": [ # 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.
				441	{ # The details of an update to a `MembershipRole`.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	442	"fieldMask": "A String", # The fully-qualified names of fields to update. May only contain the field `expiry_detail.expire_time`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	443	"membershipRole": { # 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`.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	444	"expiryDetail": { # 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.
				445	"expireTime": "A String", # The time at which the `MembershipRole` will expire.
				446	},
				447	"name": "A String", # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
yoshi-code-bot	9d63883	2021-10-05 00:20:14 -0700	[diff] [blame]	448	"restrictionEvaluations": { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership.
				449	"memberRestrictionEvaluation": { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
				450	"state": "A String", # Output only. The current state of the restriction
				451	},
				452	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	453	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	454	},
				455	],
				456	}
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	457
				458	x__xgafv: string, V1 error format.
				459	Allowed values
				460	1 - v1 error format
				461	2 - v2 error format
				462
				463	Returns:
				464	An object of the form:
				465
				466	{ # The response message for MembershipsService.ModifyMembershipRoles.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	467	"membership": { # 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 "member". # The `Membership` resource after modifying its `MembershipRole`s.
				468	"createTime": "A String", # Output only. The time when the `Membership` was created.
				469	"memberKey": { # 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.
				470	"id": "A 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's requirements. Must be unique within a `namespace`.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	471	"namespace": "A 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}`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	472	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	473	"name": "A String", # 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}`.
				474	"preferredMemberKey": { # 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.
				475	"id": "A 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's requirements. Must be unique within a `namespace`.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	476	"namespace": "A 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}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	477	},
				478	"roles": [ # 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`.
				479	{ # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
				480	"expiryDetail": { # 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.
				481	"expireTime": "A String", # The time at which the `MembershipRole` will expire.
				482	},
				483	"name": "A String", # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
yoshi-code-bot	9d63883	2021-10-05 00:20:14 -0700	[diff] [blame]	484	"restrictionEvaluations": { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership.
				485	"memberRestrictionEvaluation": { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
				486	"state": "A String", # Output only. The current state of the restriction
				487	},
				488	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	489	},
				490	],
				491	"type": "A String", # Output only. The type of the membership.
				492	"updateTime": "A String", # Output only. The time when the `Membership` was last updated.
				493	},
				494	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	495	</div>
				496
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	497	<div class="method">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	498	<code class="details" id="searchTransitiveGroups">searchTransitiveGroups(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	499	<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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	500
				501	Args:
				502	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 '-' as this API will search across all groups for a given member. (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	503	pageSize: integer, The default page size is 200 (max 1000).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	504	pageToken: string, The next_page_token value returned from a previous list request, if any.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	505	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 ('in') is supported on labels. Identity-mapped groups are uniquely identified by both a `member_key_id` and a `member_key_namespace`, which requires an additional query input: `member_key_namespace`. Example query: `member_key_id == 'member_key_id_value' && in labels`
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	506	x__xgafv: string, V1 error format.
				507	Allowed values
				508	1 - v1 error format
				509	2 - v2 error format
				510
				511	Returns:
				512	An object of the form:
				513
				514	{ # The response message for MembershipsService.SearchTransitiveGroups.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	515	"memberships": [ # List of transitive groups satisfying the query.
				516	{ # Message representing a transitive group of a user or a group.
				517	"displayName": "A String", # Display name for this group.
				518	"group": "A String", # Resource name for this group.
				519	"groupKey": { # 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.
				520	"id": "A 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's requirements. Must be unique within a `namespace`.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	521	"namespace": "A 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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	522	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	523	"labels": { # Labels for Group resource.
				524	"a_key": "A String",
				525	},
				526	"relationType": "A String", # The relation between the member and the transitive group.
				527	"roles": [ # Membership roles of the member for the group.
				528	{ # Message representing the role of a TransitiveMembership.
				529	"role": "A String", # TransitiveMembershipRole in string format. Currently supported TransitiveMembershipRoles: `"MEMBER"`, `"OWNER"`, and `"MANAGER"`.
				530	},
				531	],
				532	},
				533	],
				534	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results available for listing.
				535	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	536	</div>
				537
				538	<div class="method">
				539	<code class="details" id="searchTransitiveGroups_next">searchTransitiveGroups_next(previous_request, previous_response)</code>
				540	<pre>Retrieves the next page of results.
				541
				542	Args:
				543	previous_request: The request for the previous page. (required)
				544	previous_response: The response from the request for the previous page. (required)
				545
				546	Returns:
				547	A request object that you can call 'execute()' on to request the next
				548	page. Returns None if there are no more items in the collection.
				549	</pre>
				550	</div>
				551
				552	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	553	<code class="details" id="searchTransitiveMemberships">searchTransitiveMemberships(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	554	<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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	555
				556	Args:
				557	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)
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	558	pageSize: integer, The default page size is 200 (max 1000).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	559	pageToken: string, The next_page_token value returned from a previous list request, if any.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	560	x__xgafv: string, V1 error format.
				561	Allowed values
				562	1 - v1 error format
				563	2 - v2 error format
				564
				565	Returns:
				566	An object of the form:
				567
				568	{ # The response message for MembershipsService.SearchTransitiveMemberships.
yoshi-code-bot	f4773f6	2021-10-19 00:22:31 -0700	[diff] [blame]	569	"memberships": [ # List of transitive memberships satisfying the query.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	570	{ # Message representing a transitive membership of a group.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	571	"member": "A String", # Resource name for this member.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	572	"preferredMemberKey": [ # Entity key has an id and a namespace. In case of discussion forums, the id will be an email address without a namespace.
				573	{ # 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.
				574	"id": "A 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's requirements. Must be unique within a `namespace`.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	575	"namespace": "A 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}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	576	},
				577	],
yoshi-code-bot	f4773f6	2021-10-19 00:22:31 -0700	[diff] [blame]	578	"relationType": "A String", # The relation between the group and the transitive membership.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	579	"roles": [ # The membership role details (i.e name of role and expiry time).
				580	{ # Message representing the role of a TransitiveMembership.
				581	"role": "A String", # TransitiveMembershipRole in string format. Currently supported TransitiveMembershipRoles: `"MEMBER"`, `"OWNER"`, and `"MANAGER"`.
				582	},
				583	],
				584	},
				585	],
				586	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results.
				587	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	588	</div>
				589
				590	<div class="method">
				591	<code class="details" id="searchTransitiveMemberships_next">searchTransitiveMemberships_next(previous_request, previous_response)</code>
				592	<pre>Retrieves the next page of results.
				593
				594	Args:
				595	previous_request: The request for the previous page. (required)
				596	previous_response: The response from the request for the previous page. (required)
				597
				598	Returns:
				599	A request object that you can call 'execute()' on to request the next
				600	page. Returns None if there are no more items in the collection.
				601	</pre>
				602	</div>
				603
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	604	</body></html>