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

blob: 18dd332bef1b2616355eaecea3235d7ad87f0ffa [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-code-bot	9d63883	2021-10-05 00:20:14 -0700	[diff] [blame]	95	<code><a href="#getSecuritySettings">getSecuritySettings(name, readMask=None, x__xgafv=None)</a></code></p>
				96	<p class="firstline">Get Security Settings</p>
				97	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	98	<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]	99	<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]	100	<p class="toc_element">
				101	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				102	<p class="firstline">Retrieves the next page of results.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	103	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	104	<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]	105	<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]	106	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	107	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				108	<p class="firstline">Updates a `Group`.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	109	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	110	<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]	111	<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]	112	<p class="toc_element">
				113	<code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
				114	<p class="firstline">Retrieves the next page of results.</p>
yoshi-code-bot	9d63883	2021-10-05 00:20:14 -0700	[diff] [blame]	115	<p class="toc_element">
				116	<code><a href="#updateSecuritySettings">updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				117	<p class="firstline">Update Security Settings</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	118	<h3>Method Details</h3>
				119	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	120	<code class="details" id="close">close()</code>
				121	<pre>Close httplib2 connections.</pre>
				122	</div>
				123
				124	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	125	<code class="details" id="create">create(body=None, initialGroupConfig=None, x__xgafv=None)</code>
				126	<pre>Creates a `Group`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	127
				128	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	129	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	130	The object takes the form of:
				131
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	132	{ # 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]	133	"additionalGroupKeys": [ # Additional entity key aliases for a Group.
				134	{ # 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]	135	"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]	136	"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]	137	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	138	],
				139	"createTime": "A String", # Output only. The time when the `Group` was created.
				140	"description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
				141	"displayName": "A String", # The display name of the `Group`.
				142	"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]	143	"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]	144	{ # Defines a query on a resource.
yoshi-code-bot	ad81f3d	2021-09-28 00:22:30 -0700	[diff] [blame]	145	"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')` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase('jOhn DoE')`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	146	"resourceType": "A String",
				147	},
				148	],
				149	"status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
				150	"status": "A String", # Status of the dynamic group.
				151	"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.
				152	},
				153	},
				154	"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`.
				155	"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]	156	"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]	157	},
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	158	"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]	159	"a_key": "A String",
				160	},
				161	"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]	162	"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]	163	"posixGroups": [ # Optional. The POSIX groups associated with the `Group`.
				164	{ # POSIX Group definition to represent a group in a POSIX compliant system.
				165	"gid": "A String", # GID of the POSIX group.
				166	"name": "A String", # Name of the POSIX group.
				167	"systemId": "A String", # System identifier for which group name and gid apply to. If not specified it will default to empty value.
				168	},
				169	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	170	"updateTime": "A String", # Output only. The time when the `Group` was last updated.
				171	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	172
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	173	initialGroupConfig: string, Required. The initial configuration option for the `Group`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	174	Allowed values
				175	INITIAL_GROUP_CONFIG_UNSPECIFIED - Default. Should not be used.
				176	WITH_INITIAL_OWNER - The end user making the request will be added as the initial owner of the `Group`.
				177	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]	178	x__xgafv: string, V1 error format.
				179	Allowed values
				180	1 - v1 error format
				181	2 - v2 error format
				182
				183	Returns:
				184	An object of the form:
				185
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	186	{ # 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]	187	"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.
				188	"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.
				189	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				190	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				191	{
				192	"a_key": "", # Properties of the object. Contains field @type with type URL.
				193	},
				194	],
				195	"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.
				196	},
				197	"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.
				198	"a_key": "", # Properties of the object. Contains field @type with type URL.
				199	},
				200	"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}`.
				201	"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`.
				202	"a_key": "", # Properties of the object. Contains field @type with type URL.
				203	},
				204	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	205	</div>
				206
				207	<div class="method">
				208	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	209	<pre>Deletes a `Group`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	210
				211	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	212	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]	213	x__xgafv: string, V1 error format.
				214	Allowed values
				215	1 - v1 error format
				216	2 - v2 error format
				217
				218	Returns:
				219	An object of the form:
				220
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	221	{ # 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]	222	"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.
				223	"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.
				224	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				225	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				226	{
				227	"a_key": "", # Properties of the object. Contains field @type with type URL.
				228	},
				229	],
				230	"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.
				231	},
				232	"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.
				233	"a_key": "", # Properties of the object. Contains field @type with type URL.
				234	},
				235	"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}`.
				236	"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`.
				237	"a_key": "", # Properties of the object. Contains field @type with type URL.
				238	},
				239	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	240	</div>
				241
				242	<div class="method">
				243	<code class="details" id="get">get(name, x__xgafv=None)</code>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	244	<pre>Retrieves a `Group`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	245
				246	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	247	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]	248	x__xgafv: string, V1 error format.
				249	Allowed values
				250	1 - v1 error format
				251	2 - v2 error format
				252
				253	Returns:
				254	An object of the form:
				255
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	256	{ # 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]	257	"additionalGroupKeys": [ # Additional entity key aliases for a Group.
				258	{ # 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.
				259	"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]	260	"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]	261	},
				262	],
				263	"createTime": "A String", # Output only. The time when the `Group` was created.
				264	"description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
				265	"displayName": "A String", # The display name of the `Group`.
				266	"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]	267	"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]	268	{ # Defines a query on a resource.
yoshi-code-bot	ad81f3d	2021-09-28 00:22:30 -0700	[diff] [blame]	269	"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')` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase('jOhn DoE')`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	270	"resourceType": "A String",
				271	},
				272	],
				273	"status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
				274	"status": "A String", # Status of the dynamic group.
				275	"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.
				276	},
				277	},
				278	"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`.
				279	"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]	280	"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]	281	},
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	282	"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]	283	"a_key": "A String",
				284	},
				285	"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]	286	"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]	287	"posixGroups": [ # Optional. The POSIX groups associated with the `Group`.
				288	{ # POSIX Group definition to represent a group in a POSIX compliant system.
				289	"gid": "A String", # GID of the POSIX group.
				290	"name": "A String", # Name of the POSIX group.
				291	"systemId": "A String", # System identifier for which group name and gid apply to. If not specified it will default to empty value.
				292	},
				293	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	294	"updateTime": "A String", # Output only. The time when the `Group` was last updated.
				295	}</pre>
				296	</div>
				297
				298	<div class="method">
yoshi-code-bot	9d63883	2021-10-05 00:20:14 -0700	[diff] [blame]	299	<code class="details" id="getSecuritySettings">getSecuritySettings(name, readMask=None, x__xgafv=None)</code>
				300	<pre>Get Security Settings
				301
				302	Args:
				303	name: string, Required. The security settings to retrieve. Format: `groups/{group_id}/securitySettings` (required)
				304	readMask: string, Field-level read mask of which fields to return. "*" returns all fields. If not specified, all fields will be returned. May only contain the following field: `member_restriction`.
				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 definiion of security settings.
				314	"memberRestriction": { # The definition of MemberRestriction # The Member Restriction value
				315	"evaluation": { # The evaluated state of this restriction. # The evaluated state of this restriction on a group.
				316	"state": "A String", # Output only. The current state of the restriction
				317	},
				318	"query": "A String", # Member Restriction as defined by CEL expression. Supported restrictions are: `member.customer_id` and `member.type`. Valid values for `member.type` are `1`, `2` and `3`. They correspond to USER, SERVICE_ACCOUNT, and GROUP respectively. The value for `member.customer_id` only supports `groupCustomerId()` currently which means the customer id of the group will be used for restriction. Supported operators are `&&`, `\|\|` and `==`, corresponding to AND, OR, and EQUAL. Examples: Allow only service accounts of given customer to be members. `member.type == 2 && member.customer_id == groupCustomerId()` Allow only users or groups to be members. `member.type == 1 \|\| member.type == 3`
				319	},
				320	"name": "A String", # Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`.
				321	}</pre>
				322	</div>
				323
				324	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	325	<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]	326	<pre>Lists the `Group` resources under a customer or namespace.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	327
				328	Args:
				329	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`.
				330	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]	331	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]	332	view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
				333	Allowed values
				334	VIEW_UNSPECIFIED - Default. Should not be used.
				335	BASIC - Only basic resource information is returned.
				336	FULL - All resource information is returned.
				337	x__xgafv: string, V1 error format.
				338	Allowed values
				339	1 - v1 error format
				340	2 - v2 error format
				341
				342	Returns:
				343	An object of the form:
				344
				345	{ # The response message for GroupsService.ListGroups.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	346	"groups": [ # The `Group` resources under the specified `parent`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	347	{ # 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.
				348	"additionalGroupKeys": [ # Additional entity key aliases for a Group.
				349	{ # 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.
				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	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	352	},
				353	],
				354	"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]	355	"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]	356	"displayName": "A String", # The display name of the `Group`.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	357	"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]	358	"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]	359	{ # Defines a query on a resource.
yoshi-code-bot	ad81f3d	2021-09-28 00:22:30 -0700	[diff] [blame]	360	"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')` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase('jOhn DoE')`
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	361	"resourceType": "A String",
				362	},
				363	],
				364	"status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
				365	"status": "A String", # Status of the dynamic group.
				366	"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.
				367	},
				368	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	369	"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]	370	"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]	371	"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]	372	},
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	373	"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]	374	"a_key": "A String",
				375	},
				376	"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]	377	"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]	378	"posixGroups": [ # Optional. The POSIX groups associated with the `Group`.
				379	{ # POSIX Group definition to represent a group in a POSIX compliant system.
				380	"gid": "A String", # GID of the POSIX group.
				381	"name": "A String", # Name of the POSIX group.
				382	"systemId": "A String", # System identifier for which group name and gid apply to. If not specified it will default to empty value.
				383	},
				384	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	385	"updateTime": "A String", # Output only. The time when the `Group` was last updated.
				386	},
				387	],
				388	"nextPageToken": "A String", # A continuation token to retrieve the next page of results, or empty if there are no more results available.
				389	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	390	</div>
				391
				392	<div class="method">
				393	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				394	<pre>Retrieves the next page of results.
				395
				396	Args:
				397	previous_request: The request for the previous page. (required)
				398	previous_response: The response from the request for the previous page. (required)
				399
				400	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	401	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]	402	page. Returns None if there are no more items in the collection.
				403	</pre>
				404	</div>
				405
				406	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	407	<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]	408	<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]	409
				410	Args:
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	411	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]	412	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]	413	x__xgafv: string, V1 error format.
				414	Allowed values
				415	1 - v1 error format
				416	2 - v2 error format
				417
				418	Returns:
				419	An object of the form:
				420
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	421	{ # The response message for GroupsService.LookupGroupName.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	422	"name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Group`.
				423	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	424	</div>
				425
				426	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	427	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				428	<pre>Updates a `Group`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	429
				430	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	431	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]	432	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	433	The object takes the form of:
				434
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	435	{ # 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]	436	"additionalGroupKeys": [ # Additional entity key aliases for a Group.
				437	{ # 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]	438	"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]	439	"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]	440	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	441	],
				442	"createTime": "A String", # Output only. The time when the `Group` was created.
				443	"description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
				444	"displayName": "A String", # The display name of the `Group`.
				445	"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]	446	"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]	447	{ # Defines a query on a resource.
yoshi-code-bot	ad81f3d	2021-09-28 00:22:30 -0700	[diff] [blame]	448	"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')` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase('jOhn DoE')`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	449	"resourceType": "A String",
				450	},
				451	],
				452	"status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
				453	"status": "A String", # Status of the dynamic group.
				454	"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.
				455	},
				456	},
				457	"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`.
				458	"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]	459	"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]	460	},
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	461	"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]	462	"a_key": "A String",
				463	},
				464	"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]	465	"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]	466	"posixGroups": [ # Optional. The POSIX groups associated with the `Group`.
				467	{ # POSIX Group definition to represent a group in a POSIX compliant system.
				468	"gid": "A String", # GID of the POSIX group.
				469	"name": "A String", # Name of the POSIX group.
				470	"systemId": "A String", # System identifier for which group name and gid apply to. If not specified it will default to empty value.
				471	},
				472	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	473	"updateTime": "A String", # Output only. The time when the `Group` was last updated.
				474	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	475
yoshi-code-bot	e5e87b1	2021-09-14 00:22:34 -0700	[diff] [blame]	476	updateMask: string, Required. The names of fields to update. May only contain the following field names: `display_name`, `description`, `labels`, `dynamic_group_metadata`, `posix_groups`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	477	x__xgafv: string, V1 error format.
				478	Allowed values
				479	1 - v1 error format
				480	2 - v2 error format
				481
				482	Returns:
				483	An object of the form:
				484
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	485	{ # 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]	486	"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.
				487	"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.
				488	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				489	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				490	{
				491	"a_key": "", # Properties of the object. Contains field @type with type URL.
				492	},
				493	],
				494	"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.
				495	},
				496	"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.
				497	"a_key": "", # Properties of the object. Contains field @type with type URL.
				498	},
				499	"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}`.
				500	"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`.
				501	"a_key": "", # Properties of the object. Contains field @type with type URL.
				502	},
				503	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	504	</div>
				505
				506	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	507	<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]	508	<pre>Searches for `Group` resources matching a specified query.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	509
				510	Args:
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	511	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]	512	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]	513	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]	514	view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
				515	Allowed values
				516	BASIC - Default. Only basic resource information is returned.
				517	FULL - All resource information is returned.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	518	x__xgafv: string, V1 error format.
				519	Allowed values
				520	1 - v1 error format
				521	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	522
				523	Returns:
				524	An object of the form:
				525
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	526	{ # The response message for GroupsService.SearchGroups.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	527	"groups": [ # The `Group` resources that match the search query.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	528	{ # 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.
				529	"additionalGroupKeys": [ # Additional entity key aliases for a Group.
				530	{ # 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.
				531	"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]	532	"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]	533	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	534	],
				535	"createTime": "A String", # Output only. The time when the `Group` was created.
				536	"description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
				537	"displayName": "A String", # The display name of the `Group`.
				538	"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]	539	"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]	540	{ # Defines a query on a resource.
yoshi-code-bot	ad81f3d	2021-09-28 00:22:30 -0700	[diff] [blame]	541	"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')` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase('jOhn DoE')`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	542	"resourceType": "A String",
				543	},
				544	],
				545	"status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
				546	"status": "A String", # Status of the dynamic group.
				547	"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.
				548	},
				549	},
				550	"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`.
				551	"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]	552	"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]	553	},
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	554	"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]	555	"a_key": "A String",
				556	},
				557	"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]	558	"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]	559	"posixGroups": [ # Optional. The POSIX groups associated with the `Group`.
				560	{ # POSIX Group definition to represent a group in a POSIX compliant system.
				561	"gid": "A String", # GID of the POSIX group.
				562	"name": "A String", # Name of the POSIX group.
				563	"systemId": "A String", # System identifier for which group name and gid apply to. If not specified it will default to empty value.
				564	},
				565	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	566	"updateTime": "A String", # Output only. The time when the `Group` was last updated.
				567	},
				568	],
				569	"nextPageToken": "A String", # A continuation token to retrieve the next page of results, or empty if there are no more results available.
				570	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	571	</div>
				572
				573	<div class="method">
				574	<code class="details" id="search_next">search_next(previous_request, previous_response)</code>
				575	<pre>Retrieves the next page of results.
				576
				577	Args:
				578	previous_request: The request for the previous page. (required)
				579	previous_response: The response from the request for the previous page. (required)
				580
				581	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	582	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]	583	page. Returns None if there are no more items in the collection.
				584	</pre>
				585	</div>
				586
yoshi-code-bot	9d63883	2021-10-05 00:20:14 -0700	[diff] [blame]	587	<div class="method">
				588	<code class="details" id="updateSecuritySettings">updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None)</code>
				589	<pre>Update Security Settings
				590
				591	Args:
				592	name: string, Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`. (required)
				593	body: object, The request body.
				594	The object takes the form of:
				595
				596	{ # The definiion of security settings.
				597	"memberRestriction": { # The definition of MemberRestriction # The Member Restriction value
				598	"evaluation": { # The evaluated state of this restriction. # The evaluated state of this restriction on a group.
				599	"state": "A String", # Output only. The current state of the restriction
				600	},
				601	"query": "A String", # Member Restriction as defined by CEL expression. Supported restrictions are: `member.customer_id` and `member.type`. Valid values for `member.type` are `1`, `2` and `3`. They correspond to USER, SERVICE_ACCOUNT, and GROUP respectively. The value for `member.customer_id` only supports `groupCustomerId()` currently which means the customer id of the group will be used for restriction. Supported operators are `&&`, `\|\|` and `==`, corresponding to AND, OR, and EQUAL. Examples: Allow only service accounts of given customer to be members. `member.type == 2 && member.customer_id == groupCustomerId()` Allow only users or groups to be members. `member.type == 1 \|\| member.type == 3`
				602	},
				603	"name": "A String", # Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`.
				604	}
				605
				606	updateMask: string, Required. The fully-qualified names of fields to update. May only contain the following field: `member_restriction.query`.
				607	x__xgafv: string, V1 error format.
				608	Allowed values
				609	1 - v1 error format
				610	2 - v2 error format
				611
				612	Returns:
				613	An object of the form:
				614
				615	{ # This resource represents a long-running operation that is the result of a network API call.
				616	"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.
				617	"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.
				618	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				619	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				620	{
				621	"a_key": "", # Properties of the object. Contains field @type with type URL.
				622	},
				623	],
				624	"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.
				625	},
				626	"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.
				627	"a_key": "", # Properties of the object. Contains field @type with type URL.
				628	},
				629	"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}`.
				630	"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`.
				631	"a_key": "", # Properties of the object. Contains field @type with type URL.
				632	},
				633	}</pre>
				634	</div>
				635
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	636	</body></html>