blob: 198943fb003bcafc46feba3532bc6303efbc2288 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudidentity_v1.html">Cloud Identity API</a> . <a href="cloudidentity_v1.groups.html">groups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="cloudidentity_v1.groups.memberships.html">memberships()</a></code>
79</p>
80<p class="firstline">Returns the memberships Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070083 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
86 <code><a href="#create">create(body=None, initialGroupConfig=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070087<p class="firstline">Creates a Group.</p>
88<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070090<p class="firstline">Deletes a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070093<p class="firstline">Retrieves a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="toc_element">
yoshi-code-bot278a4902021-12-14 03:32:50 -080095 <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 Botcc94ec82021-01-15 07:10:04 -080098 <code><a href="#list">list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)</a></code></p>
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -070099<p class="firstline">Lists the `Group` resources under a customer or namespace.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<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>
103<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800104 <code><a href="#lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700105<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 Kim715bd7f2019-06-14 16:50:42 -0700106<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700107 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700108<p class="firstline">Updates a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800110 <code><a href="#search">search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)</a></code></p>
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700111<p class="firstline">Searches for `Group` resources matching a specified query.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700112<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-bot278a4902021-12-14 03:32:50 -0800115<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 Kim715bd7f2019-06-14 16:50:42 -0700118<h3>Method Details</h3>
119<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700120 <code class="details" id="close">close()</code>
121 <pre>Close httplib2 connections.</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="create">create(body=None, initialGroupConfig=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700126 <pre>Creates a Group.
127
128Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700129 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700130 The object takes the form of:
131
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700132{ # 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 Bot0bf565c2020-12-09 08:56:03 -0800133 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800134 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
135 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800136 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
137 &quot;queries&quot;: [ # 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.
138 { # Defines a query on a resource.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700139 &quot;query&quot;: &quot;A String&quot;, # 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==&#x27;engineering&#x27;)` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area==&#x27;foo&#x27; &amp;&amp; loc.building_id==&#x27;bar&#x27;)` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase(&#x27;jOhn DoE&#x27;)`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800140 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
141 },
142 ],
143 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
144 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
145 &quot;statusTime&quot;: &quot;A String&quot;, # 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 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800148 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the `Group`.
149 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700150 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source}`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800151 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700152 &quot;labels&quot;: { # 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 Bot0bf565c2020-12-09 08:56:03 -0800153 &quot;a_key&quot;: &quot;A String&quot;,
154 },
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700155 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`.
156 &quot;parent&quot;: &quot;A String&quot;, # 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}` for external- identity-mapped groups or `customers/{customer}` for Google Groups. The `customer` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800157 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800158}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700159
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700160 initialGroupConfig: string, Optional. The initial configuration option for the `Group`.
161 Allowed values
162 INITIAL_GROUP_CONFIG_UNSPECIFIED - Default. Should not be used.
163 WITH_INITIAL_OWNER - The end user making the request will be added as the initial owner of the `Group`.
164 EMPTY - An empty group is created without any initial owners. This can only be used by admins of the domain.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
169
170Returns:
171 An object of the form:
172
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700173 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800174 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
175 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
176 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
177 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
178 {
179 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
180 },
181 ],
182 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
183 },
184 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
185 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
186 },
187 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
188 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
189 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
190 },
191}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700192</div>
193
194<div class="method">
195 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700196 <pre>Deletes a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700197
198Args:
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700199 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}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700200 x__xgafv: string, V1 error format.
201 Allowed values
202 1 - v1 error format
203 2 - v2 error format
204
205Returns:
206 An object of the form:
207
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700208 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800209 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
210 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
211 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
212 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
213 {
214 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
215 },
216 ],
217 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
218 },
219 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
220 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
221 },
222 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
223 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
224 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
225 },
226}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700227</div>
228
229<div class="method">
230 <code class="details" id="get">get(name, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700231 <pre>Retrieves a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700232
233Args:
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700234 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}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700235 x__xgafv: string, V1 error format.
236 Allowed values
237 1 - v1 error format
238 2 - v2 error format
239
240Returns:
241 An object of the form:
242
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700243 { # 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 Botcc94ec82021-01-15 07:10:04 -0800244 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
245 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
246 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800247 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
248 &quot;queries&quot;: [ # 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.
249 { # Defines a query on a resource.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700250 &quot;query&quot;: &quot;A String&quot;, # 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==&#x27;engineering&#x27;)` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area==&#x27;foo&#x27; &amp;&amp; loc.building_id==&#x27;bar&#x27;)` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase(&#x27;jOhn DoE&#x27;)`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800251 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
252 },
253 ],
254 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
255 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
256 &quot;statusTime&quot;: &quot;A String&quot;, # 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.
257 },
258 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800259 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the `Group`.
260 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700261 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800262 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700263 &quot;labels&quot;: { # 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 Botcc94ec82021-01-15 07:10:04 -0800264 &quot;a_key&quot;: &quot;A String&quot;,
265 },
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700266 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`.
267 &quot;parent&quot;: &quot;A String&quot;, # 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}` for external- identity-mapped groups or `customers/{customer}` for Google Groups. The `customer` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800268 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
269}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700270</div>
271
272<div class="method">
yoshi-code-bot278a4902021-12-14 03:32:50 -0800273 <code class="details" id="getSecuritySettings">getSecuritySettings(name, readMask=None, x__xgafv=None)</code>
274 <pre>Get Security Settings
275
276Args:
277 name: string, Required. The security settings to retrieve. Format: `groups/{group_id}/securitySettings` (required)
278 readMask: string, Field-level read mask of which fields to return. &quot;*&quot; returns all fields. If not specified, all fields will be returned. May only contain the following field: `member_restriction`.
279 x__xgafv: string, V1 error format.
280 Allowed values
281 1 - v1 error format
282 2 - v2 error format
283
284Returns:
285 An object of the form:
286
287 { # The definition of security settings.
288 &quot;memberRestriction&quot;: { # The definition of MemberRestriction # The Member Restriction value
289 &quot;evaluation&quot;: { # The evaluated state of this restriction. # The evaluated state of this restriction on a group.
290 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
291 },
292 &quot;query&quot;: &quot;A String&quot;, # 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 `&amp;&amp;`, `||` and `==`, corresponding to AND, OR, and EQUAL. Examples: Allow only service accounts of given customer to be members. `member.type == 2 &amp;&amp; member.customer_id == groupCustomerId()` Allow only users or groups to be members. `member.type == 1 || member.type == 3`
293 },
294 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`.
295}</pre>
296</div>
297
298<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800299 <code class="details" id="list">list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)</code>
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700300 <pre>Lists the `Group` resources under a customer or namespace.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700301
302Args:
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800303 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`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800304 pageToken: string, The `next_page_token` value returned from a previous list request, if any.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700305 parent: string, Required. The parent resource under which to list all `Group` resources. Must be of the form `identitysources/{identity_source}` for external- identity-mapped groups or `customers/{customer}` for Google Groups. The `customer` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700306 view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700307 Allowed values
308 VIEW_UNSPECIFIED - Default. Should not be used.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700309 BASIC - Only basic resource information is returned.
310 FULL - All resource information is returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700311 x__xgafv: string, V1 error format.
312 Allowed values
313 1 - v1 error format
314 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700315
316Returns:
317 An object of the form:
318
319 { # Response message for ListGroups operation.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800320 &quot;groups&quot;: [ # Groups returned in response to list request. The results are not sorted.
321 { # 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.
322 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
323 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
324 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800325 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
326 &quot;queries&quot;: [ # 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.
327 { # Defines a query on a resource.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700328 &quot;query&quot;: &quot;A String&quot;, # 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==&#x27;engineering&#x27;)` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area==&#x27;foo&#x27; &amp;&amp; loc.building_id==&#x27;bar&#x27;)` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase(&#x27;jOhn DoE&#x27;)`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800329 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
330 },
331 ],
332 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
333 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
334 &quot;statusTime&quot;: &quot;A String&quot;, # 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 Botcc94ec82021-01-15 07:10:04 -0800337 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the `Group`.
338 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700339 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source}`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800340 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700341 &quot;labels&quot;: { # 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 Botcc94ec82021-01-15 07:10:04 -0800342 &quot;a_key&quot;: &quot;A String&quot;,
343 },
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700344 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`.
345 &quot;parent&quot;: &quot;A String&quot;, # 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}` for external- identity-mapped groups or `customers/{customer}` for Google Groups. The `customer` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800346 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
347 },
348 ],
349 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results available for listing.
350}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700351</div>
352
353<div class="method">
354 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
355 <pre>Retrieves the next page of results.
356
357Args:
358 previous_request: The request for the previous page. (required)
359 previous_response: The response from the request for the previous page. (required)
360
361Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700362 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700363 page. Returns None if there are no more items in the collection.
364 </pre>
365</div>
366
367<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800368 <code class="details" id="lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700369 <pre>Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700370
371Args:
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800372 groupKey_id: string, The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700373 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}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700374 x__xgafv: string, V1 error format.
375 Allowed values
376 1 - v1 error format
377 2 - v2 error format
378
379Returns:
380 An object of the form:
381
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700382 { # The response message for GroupsService.LookupGroupName.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800383 &quot;name&quot;: &quot;A String&quot;, # The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Group`.
384}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700385</div>
386
387<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700388 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700389 <pre>Updates a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700390
391Args:
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700392 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}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700393 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700394 The object takes the form of:
395
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700396{ # 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 Bot0bf565c2020-12-09 08:56:03 -0800397 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800398 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
399 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800400 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
401 &quot;queries&quot;: [ # 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.
402 { # Defines a query on a resource.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700403 &quot;query&quot;: &quot;A String&quot;, # 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==&#x27;engineering&#x27;)` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area==&#x27;foo&#x27; &amp;&amp; loc.building_id==&#x27;bar&#x27;)` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase(&#x27;jOhn DoE&#x27;)`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800404 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
405 },
406 ],
407 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
408 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
409 &quot;statusTime&quot;: &quot;A String&quot;, # 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.
410 },
411 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800412 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the `Group`.
413 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700414 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source}`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800415 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700416 &quot;labels&quot;: { # 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 Bot0bf565c2020-12-09 08:56:03 -0800417 &quot;a_key&quot;: &quot;A String&quot;,
418 },
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700419 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`.
420 &quot;parent&quot;: &quot;A String&quot;, # 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}` for external- identity-mapped groups or `customers/{customer}` for Google Groups. The `customer` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800421 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800422}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700423
yoshi-code-bote5e87b12021-09-14 00:22:34 -0700424 updateMask: string, Required. The names of fields to update. May only contain the following field names: `display_name`, `description`, `labels`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700425 x__xgafv: string, V1 error format.
426 Allowed values
427 1 - v1 error format
428 2 - v2 error format
429
430Returns:
431 An object of the form:
432
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700433 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800434 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
435 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
436 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
437 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
438 {
439 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
440 },
441 ],
442 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
443 },
444 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
445 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
446 },
447 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
448 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
449 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
450 },
451}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700452</div>
453
454<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800455 <code class="details" id="search">search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)</code>
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700456 <pre>Searches for `Group` resources matching a specified query.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700457
458Args:
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800459 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 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800460 pageToken: string, The `next_page_token` value returned from a previous search request, if any.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700461 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 == &#x27;customers/{customer}&#x27; &amp;&amp; &#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27; in labels`). The `customer` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700462 view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700463 Allowed values
464 VIEW_UNSPECIFIED - Default. Should not be used.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700465 BASIC - Only basic resource information is returned.
466 FULL - All resource information is returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700467 x__xgafv: string, V1 error format.
468 Allowed values
469 1 - v1 error format
470 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700471
472Returns:
473 An object of the form:
474
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700475 { # The response message for GroupsService.SearchGroups.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700476 &quot;groups&quot;: [ # The `Group` resources that match the search query.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800477 { # 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.
478 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
479 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
480 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800481 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
482 &quot;queries&quot;: [ # 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.
483 { # Defines a query on a resource.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700484 &quot;query&quot;: &quot;A String&quot;, # 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==&#x27;engineering&#x27;)` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area==&#x27;foo&#x27; &amp;&amp; loc.building_id==&#x27;bar&#x27;)` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase(&#x27;jOhn DoE&#x27;)`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800485 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
486 },
487 ],
488 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
489 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
490 &quot;statusTime&quot;: &quot;A String&quot;, # 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.
491 },
492 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800493 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the `Group`.
494 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700495 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source}`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800496 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700497 &quot;labels&quot;: { # 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 Botcc94ec82021-01-15 07:10:04 -0800498 &quot;a_key&quot;: &quot;A String&quot;,
499 },
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700500 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`.
501 &quot;parent&quot;: &quot;A String&quot;, # 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}` for external- identity-mapped groups or `customers/{customer}` for Google Groups. The `customer` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800502 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
503 },
504 ],
505 &quot;nextPageToken&quot;: &quot;A String&quot;, # A continuation token to retrieve the next page of results, or empty if there are no more results available.
506}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700507</div>
508
509<div class="method">
510 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
511 <pre>Retrieves the next page of results.
512
513Args:
514 previous_request: The request for the previous page. (required)
515 previous_response: The response from the request for the previous page. (required)
516
517Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700518 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700519 page. Returns None if there are no more items in the collection.
520 </pre>
521</div>
522
yoshi-code-bot278a4902021-12-14 03:32:50 -0800523<div class="method">
524 <code class="details" id="updateSecuritySettings">updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None)</code>
525 <pre>Update Security Settings
526
527Args:
528 name: string, Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`. (required)
529 body: object, The request body.
530 The object takes the form of:
531
532{ # The definition of security settings.
533 &quot;memberRestriction&quot;: { # The definition of MemberRestriction # The Member Restriction value
534 &quot;evaluation&quot;: { # The evaluated state of this restriction. # The evaluated state of this restriction on a group.
535 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
536 },
537 &quot;query&quot;: &quot;A String&quot;, # 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 `&amp;&amp;`, `||` and `==`, corresponding to AND, OR, and EQUAL. Examples: Allow only service accounts of given customer to be members. `member.type == 2 &amp;&amp; member.customer_id == groupCustomerId()` Allow only users or groups to be members. `member.type == 1 || member.type == 3`
538 },
539 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`.
540}
541
542 updateMask: string, Required. The fully-qualified names of fields to update. May only contain the following field: `member_restriction.query`.
543 x__xgafv: string, V1 error format.
544 Allowed values
545 1 - v1 error format
546 2 - v2 error format
547
548Returns:
549 An object of the form:
550
551 { # This resource represents a long-running operation that is the result of a network API call.
552 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
553 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
554 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
555 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
556 {
557 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
558 },
559 ],
560 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
561 },
562 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
563 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
564 },
565 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
566 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
567 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
568 },
569}</pre>
570</div>
571
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700572</body></html>