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

blob: ddec42dab3dec1c0c4c9221e4030034ba4c60485 [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></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="cloudidentity_v1beta1.groups.memberships.html">memberships()</a></code>
				79	</p>
				80	<p class="firstline">Returns the memberships Resource.</p>
				81
				82	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	83	<code><a href="#close">close()</a></code></p>
				84	<p class="firstline">Close httplib2 connections.</p>
				85	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	86	<code><a href="#create">create(body=None, initialGroupConfig=None, x__xgafv=None)</a></code></p>
				87	<p class="firstline">Creates a `Group`.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="toc_element">
				89	<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]	90	<p class="firstline">Deletes a `Group`.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	91	<p class="toc_element">
				92	<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]	93	<p class="firstline">Retrieves a `Group`.</p>
				94	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	95	<code><a href="#list">list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	96	<p class="firstline">Lists the `Group` resources under a customer or namespace.</p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	97	<p class="toc_element">
				98	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				99	<p class="firstline">Retrieves the next page of results.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	100	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	101	<code><a href="#lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	102	<p class="firstline">Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	103	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	104	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				105	<p class="firstline">Updates a `Group`.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	106	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	107	<code><a href="#search">search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	108	<p class="firstline">Searches for `Group` resources matching a specified query.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	109	<p class="toc_element">
				110	<code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
				111	<p class="firstline">Retrieves the next page of results.</p>
				112	<h3>Method Details</h3>
				113	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	114	<code class="details" id="close">close()</code>
				115	<pre>Close httplib2 connections.</pre>
				116	</div>
				117
				118	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	119	<code class="details" id="create">create(body=None, initialGroupConfig=None, x__xgafv=None)</code>
				120	<pre>Creates a `Group`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	121
				122	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	123	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	124	The object takes the form of:
				125
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	126	{ # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	127	"additionalGroupKeys": [ # Additional entity key aliases for a Group.
				128	{ # 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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	129	"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]	130	"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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	131	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	132	],
				133	"createTime": "A String", # Output only. The time when the `Group` was created.
				134	"description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
				135	"displayName": "A String", # The display name of the `Group`.
				136	"dynamicGroupMetadata": { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	137	"queries": [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	138	{ # Defines a query on a resource.
				139	"query": "A String", # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department=='engineering')` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')`
				140	"resourceType": "A String",
				141	},
				142	],
				143	"status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
				144	"status": "A String", # Status of the dynamic group.
				145	"statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created.
				146	},
				147	},
				148	"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. # Required. Immutable. The `EntityKey` of the `Group`.
				149	"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]	150	"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]	151	},
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	152	"labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	153	"a_key": "A String",
				154	},
				155	"name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	156	"parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn').
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	157	"posixGroups": [ # Optional. The POSIX groups associated with the `Group`.
				158	{ # POSIX Group definition to represent a group in a POSIX compliant system.
				159	"gid": "A String", # GID of the POSIX group.
				160	"name": "A String", # Name of the POSIX group.
				161	"systemId": "A String", # System identifier for which group name and gid apply to. If not specified it will default to empty value.
				162	},
				163	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	164	"updateTime": "A String", # Output only. The time when the `Group` was last updated.
				165	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	166
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	167	initialGroupConfig: string, Required. The initial configuration option for the `Group`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	168	Allowed values
				169	INITIAL_GROUP_CONFIG_UNSPECIFIED - Default. Should not be used.
				170	WITH_INITIAL_OWNER - The end user making the request will be added as the initial owner of the `Group`.
				171	EMPTY - An empty group is created without any initial owners. This can only be used by admins of the domain.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	172	x__xgafv: string, V1 error format.
				173	Allowed values
				174	1 - v1 error format
				175	2 - v2 error format
				176
				177	Returns:
				178	An object of the form:
				179
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	180	{ # 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]	181	"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.
				182	"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.
				183	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				184	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				185	{
				186	"a_key": "", # Properties of the object. Contains field @type with type URL.
				187	},
				188	],
				189	"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.
				190	},
				191	"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.
				192	"a_key": "", # Properties of the object. Contains field @type with type URL.
				193	},
				194	"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}`.
				195	"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`.
				196	"a_key": "", # Properties of the object. Contains field @type with type URL.
				197	},
				198	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	199	</div>
				200
				201	<div class="method">
				202	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	203	<pre>Deletes a `Group`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	204
				205	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	206	name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	207	x__xgafv: string, V1 error format.
				208	Allowed values
				209	1 - v1 error format
				210	2 - v2 error format
				211
				212	Returns:
				213	An object of the form:
				214
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	215	{ # 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]	216	"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.
				217	"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.
				218	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				219	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				220	{
				221	"a_key": "", # Properties of the object. Contains field @type with type URL.
				222	},
				223	],
				224	"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.
				225	},
				226	"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.
				227	"a_key": "", # Properties of the object. Contains field @type with type URL.
				228	},
				229	"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}`.
				230	"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`.
				231	"a_key": "", # Properties of the object. Contains field @type with type URL.
				232	},
				233	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	234	</div>
				235
				236	<div class="method">
				237	<code class="details" id="get">get(name, x__xgafv=None)</code>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	238	<pre>Retrieves a `Group`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	239
				240	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	241	name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	242	x__xgafv: string, V1 error format.
				243	Allowed values
				244	1 - v1 error format
				245	2 - v2 error format
				246
				247	Returns:
				248	An object of the form:
				249
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	250	{ # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	251	"additionalGroupKeys": [ # Additional entity key aliases for a Group.
				252	{ # 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.
				253	"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]	254	"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]	255	},
				256	],
				257	"createTime": "A String", # Output only. The time when the `Group` was created.
				258	"description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
				259	"displayName": "A String", # The display name of the `Group`.
				260	"dynamicGroupMetadata": { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	261	"queries": [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	262	{ # Defines a query on a resource.
				263	"query": "A String", # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department=='engineering')` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')`
				264	"resourceType": "A String",
				265	},
				266	],
				267	"status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
				268	"status": "A String", # Status of the dynamic group.
				269	"statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created.
				270	},
				271	},
				272	"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. # Required. Immutable. The `EntityKey` of the `Group`.
				273	"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]	274	"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]	275	},
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	276	"labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	277	"a_key": "A String",
				278	},
				279	"name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	280	"parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn').
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	281	"posixGroups": [ # Optional. The POSIX groups associated with the `Group`.
				282	{ # POSIX Group definition to represent a group in a POSIX compliant system.
				283	"gid": "A String", # GID of the POSIX group.
				284	"name": "A String", # Name of the POSIX group.
				285	"systemId": "A String", # System identifier for which group name and gid apply to. If not specified it will default to empty value.
				286	},
				287	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	288	"updateTime": "A String", # Output only. The time when the `Group` was last updated.
				289	}</pre>
				290	</div>
				291
				292	<div class="method">
				293	<code class="details" id="list">list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)</code>
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	294	<pre>Lists the `Group` resources under a customer or namespace.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	295
				296	Args:
				297	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 `View.BASIC` and to 50 for `View.FULL`. Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`.
				298	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]	299	parent: string, Required. The parent resource under which to list all `Group` resources. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn').
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	300	view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
				301	Allowed values
				302	VIEW_UNSPECIFIED - Default. Should not be used.
				303	BASIC - Only basic resource information is returned.
				304	FULL - All resource information is returned.
				305	x__xgafv: string, V1 error format.
				306	Allowed values
				307	1 - v1 error format
				308	2 - v2 error format
				309
				310	Returns:
				311	An object of the form:
				312
				313	{ # The response message for GroupsService.ListGroups.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	314	"groups": [ # The `Group` resources under the specified `parent`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	315	{ # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.
				316	"additionalGroupKeys": [ # Additional entity key aliases for a Group.
				317	{ # 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.
				318	"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]	319	"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]	320	},
				321	],
				322	"createTime": "A String", # Output only. The time when the `Group` was created.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	323	"description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	324	"displayName": "A String", # The display name of the `Group`.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	325	"dynamicGroupMetadata": { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	326	"queries": [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	327	{ # Defines a query on a resource.
				328	"query": "A String", # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department=='engineering')` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')`
				329	"resourceType": "A String",
				330	},
				331	],
				332	"status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
				333	"status": "A String", # Status of the dynamic group.
				334	"statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created.
				335	},
				336	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	337	"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. # Required. Immutable. The `EntityKey` of the `Group`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	338	"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]	339	"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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	340	},
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	341	"labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	342	"a_key": "A String",
				343	},
				344	"name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	345	"parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn').
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	346	"posixGroups": [ # Optional. The POSIX groups associated with the `Group`.
				347	{ # POSIX Group definition to represent a group in a POSIX compliant system.
				348	"gid": "A String", # GID of the POSIX group.
				349	"name": "A String", # Name of the POSIX group.
				350	"systemId": "A String", # System identifier for which group name and gid apply to. If not specified it will default to empty value.
				351	},
				352	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	353	"updateTime": "A String", # Output only. The time when the `Group` was last updated.
				354	},
				355	],
				356	"nextPageToken": "A String", # A continuation token to retrieve the next page of results, or empty if there are no more results available.
				357	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	358	</div>
				359
				360	<div class="method">
				361	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				362	<pre>Retrieves the next page of results.
				363
				364	Args:
				365	previous_request: The request for the previous page. (required)
				366	previous_response: The response from the request for the previous page. (required)
				367
				368	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	369	A request object that you can call 'execute()' on to request the next
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	370	page. Returns None if there are no more items in the collection.
				371	</pre>
				372	</div>
				373
				374	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	375	<code class="details" id="lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	376	<pre>Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	377
				378	Args:
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	379	groupKey_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]	380	groupKey_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]	381	x__xgafv: string, V1 error format.
				382	Allowed values
				383	1 - v1 error format
				384	2 - v2 error format
				385
				386	Returns:
				387	An object of the form:
				388
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	389	{ # The response message for GroupsService.LookupGroupName.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	390	"name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Group`.
				391	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	392	</div>
				393
				394	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	395	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				396	<pre>Updates a `Group`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	397
				398	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	399	name: string, Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	400	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	401	The object takes the form of:
				402
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	403	{ # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	404	"additionalGroupKeys": [ # Additional entity key aliases for a Group.
				405	{ # 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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	406	"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]	407	"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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	408	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	409	],
				410	"createTime": "A String", # Output only. The time when the `Group` was created.
				411	"description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
				412	"displayName": "A String", # The display name of the `Group`.
				413	"dynamicGroupMetadata": { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	414	"queries": [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	415	{ # Defines a query on a resource.
				416	"query": "A String", # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department=='engineering')` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')`
				417	"resourceType": "A String",
				418	},
				419	],
				420	"status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
				421	"status": "A String", # Status of the dynamic group.
				422	"statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created.
				423	},
				424	},
				425	"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. # Required. Immutable. The `EntityKey` of the `Group`.
				426	"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]	427	"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]	428	},
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	429	"labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	430	"a_key": "A String",
				431	},
				432	"name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	433	"parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn').
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	434	"posixGroups": [ # Optional. The POSIX groups associated with the `Group`.
				435	{ # POSIX Group definition to represent a group in a POSIX compliant system.
				436	"gid": "A String", # GID of the POSIX group.
				437	"name": "A String", # Name of the POSIX group.
				438	"systemId": "A String", # System identifier for which group name and gid apply to. If not specified it will default to empty value.
				439	},
				440	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	441	"updateTime": "A String", # Output only. The time when the `Group` was last updated.
				442	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	443
yoshi-code-bot	a933dad	2021-07-06 00:26:24 -0700	[diff] [blame]	444	updateMask: string, Required. The names of fields to update. May only contain the following fields: `display_name`, `description`, `labels`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	445	x__xgafv: string, V1 error format.
				446	Allowed values
				447	1 - v1 error format
				448	2 - v2 error format
				449
				450	Returns:
				451	An object of the form:
				452
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	453	{ # 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]	454	"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.
				455	"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.
				456	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				457	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				458	{
				459	"a_key": "", # Properties of the object. Contains field @type with type URL.
				460	},
				461	],
				462	"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.
				463	},
				464	"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.
				465	"a_key": "", # Properties of the object. Contains field @type with type URL.
				466	},
				467	"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}`.
				468	"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`.
				469	"a_key": "", # Properties of the object. Contains field @type with type URL.
				470	},
				471	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	472	</div>
				473
				474	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	475	<code class="details" id="search">search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)</code>
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	476	<pre>Searches for `Group` resources matching a specified query.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	477
				478	Args:
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	479	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`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	480	pageToken: string, The `next_page_token` value returned from a previous search request, if any.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	481	query: string, Required. The search query. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent and inclusion operators on labels (e.g., `parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). The `customer_id` must begin with "C" (for example, 'C046psxkn').
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	482	view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
				483	Allowed values
				484	BASIC - Default. Only basic resource information is returned.
				485	FULL - All resource information is returned.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	486	x__xgafv: string, V1 error format.
				487	Allowed values
				488	1 - v1 error format
				489	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	490
				491	Returns:
				492	An object of the form:
				493
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	494	{ # The response message for GroupsService.SearchGroups.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	495	"groups": [ # The `Group` resources that match the search query.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	496	{ # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.
				497	"additionalGroupKeys": [ # Additional entity key aliases for a Group.
				498	{ # 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.
				499	"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]	500	"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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	501	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	502	],
				503	"createTime": "A String", # Output only. The time when the `Group` was created.
				504	"description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
				505	"displayName": "A String", # The display name of the `Group`.
				506	"dynamicGroupMetadata": { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	507	"queries": [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	508	{ # Defines a query on a resource.
				509	"query": "A String", # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department=='engineering')` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')`
				510	"resourceType": "A String",
				511	},
				512	],
				513	"status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
				514	"status": "A String", # Status of the dynamic group.
				515	"statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created.
				516	},
				517	},
				518	"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. # Required. Immutable. The `EntityKey` of the `Group`.
				519	"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]	520	"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]	521	},
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	522	"labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	523	"a_key": "A String",
				524	},
				525	"name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	526	"parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn').
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	527	"posixGroups": [ # Optional. The POSIX groups associated with the `Group`.
				528	{ # POSIX Group definition to represent a group in a POSIX compliant system.
				529	"gid": "A String", # GID of the POSIX group.
				530	"name": "A String", # Name of the POSIX group.
				531	"systemId": "A String", # System identifier for which group name and gid apply to. If not specified it will default to empty value.
				532	},
				533	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	534	"updateTime": "A String", # Output only. The time when the `Group` was last updated.
				535	},
				536	],
				537	"nextPageToken": "A String", # A continuation token to retrieve the next page of results, or empty if there are no more results available.
				538	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	539	</div>
				540
				541	<div class="method">
				542	<code class="details" id="search_next">search_next(previous_request, previous_response)</code>
				543	<pre>Retrieves the next page of results.
				544
				545	Args:
				546	previous_request: The request for the previous page. (required)
				547	previous_response: The response from the request for the previous page. (required)
				548
				549	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	550	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]	551	page. Returns None if there are no more items in the collection.
				552	</pre>
				553	</div>
				554
				555	</body></html>