Debian Codegraph @

docs/dyn/cloudidentity_v1.groups.html

raw
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_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">
83 <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>
87 <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>
90 <p class="firstline">Deletes a `Group`.</p>
91 <p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93 <p class="firstline">Retrieves a `Group`.</p>
94 <p class="toc_element">
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">
98 <code><a href="#list">list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)</a></code></p>
99 <p class="firstline">Lists the `Group` resources under a customer or namespace.</p>
100 <p class="toc_element">
101 <code><a href="#list_next">list_next()</a></code></p>
102 <p class="firstline">Retrieves the next page of results.</p>
103 <p class="toc_element">
104 <code><a href="#lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</a></code></p>
105 <p class="firstline">Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.</p>
106 <p class="toc_element">
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>
109 <p class="toc_element">
110 <code><a href="#search">search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)</a></code></p>
111 <p class="firstline">Searches for `Group` resources matching a specified query.</p>
112 <p class="toc_element">
113 <code><a href="#search_next">search_next()</a></code></p>
114 <p class="firstline">Retrieves the next page of results.</p>
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>
118 <h3>Method Details</h3>
119 <div class="method">
120 <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>
126 <pre>Creates a Group.
127
128 Args:
129 body: object, The request body.
130 The object takes the form of:
131
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.
133 &quot;additionalGroupKeys&quot;: [ # Output only. Additional group keys associated with the 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.
135 &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. Email addresses need to adhere to [name guidelines for users and groups](https://support.google.com/a/answer/9193374). 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`.
136 &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}`.
137 },
138 ],
139 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
140 &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.
141 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
142 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
143 &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 500 dynamic groups.
144 { # Defines a query on a resource.
145 &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;)`
146 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
147 },
148 ],
149 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
150 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
151 &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.
152 },
153 },
154 &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. The `EntityKey` of the `Group`.
155 &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. Email addresses need to adhere to [name guidelines for users and groups](https://support.google.com/a/answer/9193374). 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`.
156 &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}`.
157 },
158 &quot;labels&quot;: { # Required. One or more label entries that apply to the Group. 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. Google Groups can be [locked](https://support.google.com/a?p=locked-groups). To lock a group, add a label with a key of `cloudidentity.googleapis.com/groups.locked` and an empty value. Doing so locks the group. To unlock the group, remove this label.
159 &quot;a_key&quot;: &quot;A String&quot;,
160 },
161 &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}`.
162 &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](https://support.google.com/a/answer/9039510) or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793)
163 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
164 }
165
166 initialGroupConfig: string, Optional. The initial configuration option for the `Group`.
167 Allowed values
168 INITIAL_GROUP_CONFIG_UNSPECIFIED - Default. Should not be used.
169 WITH_INITIAL_OWNER - The end user making the request will be added as the initial owner of the `Group`.
170 EMPTY - An empty group is created without any initial owners. This can only be used by admins of the domain.
171 x__xgafv: string, V1 error format.
172 Allowed values
173 1 - v1 error format
174 2 - v2 error format
175
176 Returns:
177 An object of the form:
178
179 { # This resource represents a long-running operation that is the result of a network API call.
180 &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.
181 &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.
182 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
183 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
184 {
185 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
186 },
187 ],
188 &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.
189 },
190 &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.
191 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
192 },
193 &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}`.
194 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
195 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
196 },
197 }</pre>
198 </div>
199
200 <div class="method">
201 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
202 <pre>Deletes a `Group`.
203
204 Args:
205 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)
206 x__xgafv: string, V1 error format.
207 Allowed values
208 1 - v1 error format
209 2 - v2 error format
210
211 Returns:
212 An object of the form:
213
214 { # This resource represents a long-running operation that is the result of a network API call.
215 &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.
216 &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.
217 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
218 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
219 {
220 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
221 },
222 ],
223 &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.
224 },
225 &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.
226 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
227 },
228 &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}`.
229 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
230 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
231 },
232 }</pre>
233 </div>
234
235 <div class="method">
236 <code class="details" id="get">get(name, x__xgafv=None)</code>
237 <pre>Retrieves a `Group`.
238
239 Args:
240 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)
241 x__xgafv: string, V1 error format.
242 Allowed values
243 1 - v1 error format
244 2 - v2 error format
245
246 Returns:
247 An object of the form:
248
249 { # 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.
250 &quot;additionalGroupKeys&quot;: [ # Output only. Additional group keys associated with the Group.
251 { # 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.
252 &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. Email addresses need to adhere to [name guidelines for users and groups](https://support.google.com/a/answer/9193374). 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`.
253 &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}`.
254 },
255 ],
256 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
257 &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.
258 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
259 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
260 &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 500 dynamic groups.
261 { # Defines a query on a resource.
262 &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;)`
263 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
264 },
265 ],
266 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
267 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
268 &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.
269 },
270 },
271 &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. The `EntityKey` of the `Group`.
272 &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. Email addresses need to adhere to [name guidelines for users and groups](https://support.google.com/a/answer/9193374). 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`.
273 &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}`.
274 },
275 &quot;labels&quot;: { # Required. One or more label entries that apply to the Group. 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. Google Groups can be [locked](https://support.google.com/a?p=locked-groups). To lock a group, add a label with a key of `cloudidentity.googleapis.com/groups.locked` and an empty value. Doing so locks the group. To unlock the group, remove this label.
276 &quot;a_key&quot;: &quot;A String&quot;,
277 },
278 &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}`.
279 &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](https://support.google.com/a/answer/9039510) or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793)
280 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
281 }</pre>
282 </div>
283
284 <div class="method">
285 <code class="details" id="getSecuritySettings">getSecuritySettings(name, readMask=None, x__xgafv=None)</code>
286 <pre>Get Security Settings
287
288 Args:
289 name: string, Required. The security settings to retrieve. Format: `groups/{group_id}/securitySettings` (required)
290 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`.
291 x__xgafv: string, V1 error format.
292 Allowed values
293 1 - v1 error format
294 2 - v2 error format
295
296 Returns:
297 An object of the form:
298
299 { # The definition of security settings.
300 &quot;memberRestriction&quot;: { # The definition of MemberRestriction # The Member Restriction value
301 &quot;evaluation&quot;: { # The evaluated state of this restriction. # The evaluated state of this restriction on a group.
302 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
303 },
304 &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`
305 },
306 &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`.
307 }</pre>
308 </div>
309
310 <div class="method">
311 <code class="details" id="list">list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)</code>
312 <pre>Lists the `Group` resources under a customer or namespace.
313
314 Args:
315 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`.
316 pageToken: string, The `next_page_token` value returned from a previous list request, if any.
317 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_id}` for Google Groups. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793)
318 view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
319 Allowed values
320 VIEW_UNSPECIFIED - Default. Should not be used.
321 BASIC - Only basic resource information is returned.
322 FULL - All resource information is returned.
323 x__xgafv: string, V1 error format.
324 Allowed values
325 1 - v1 error format
326 2 - v2 error format
327
328 Returns:
329 An object of the form:
330
331 { # Response message for ListGroups operation.
332 &quot;groups&quot;: [ # Groups returned in response to list request. The results are not sorted.
333 { # 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.
334 &quot;additionalGroupKeys&quot;: [ # Output only. Additional group keys associated with the Group.
335 { # 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.
336 &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. Email addresses need to adhere to [name guidelines for users and groups](https://support.google.com/a/answer/9193374). 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`.
337 &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}`.
338 },
339 ],
340 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
341 &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.
342 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
343 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
344 &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 500 dynamic groups.
345 { # Defines a query on a resource.
346 &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;)`
347 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
348 },
349 ],
350 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
351 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
352 &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.
353 },
354 },
355 &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. The `EntityKey` of the `Group`.
356 &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. Email addresses need to adhere to [name guidelines for users and groups](https://support.google.com/a/answer/9193374). 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`.
357 &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}`.
358 },
359 &quot;labels&quot;: { # Required. One or more label entries that apply to the Group. 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. Google Groups can be [locked](https://support.google.com/a?p=locked-groups). To lock a group, add a label with a key of `cloudidentity.googleapis.com/groups.locked` and an empty value. Doing so locks the group. To unlock the group, remove this label.
360 &quot;a_key&quot;: &quot;A String&quot;,
361 },
362 &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}`.
363 &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](https://support.google.com/a/answer/9039510) or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793)
364 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
365 },
366 ],
367 &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.
368 }</pre>
369 </div>
370
371 <div class="method">
372 <code class="details" id="list_next">list_next()</code>
373 <pre>Retrieves the next page of results.
374
375 Args:
376 previous_request: The request for the previous page. (required)
377 previous_response: The response from the request for the previous page. (required)
378
379 Returns:
380 A request object that you can call &#x27;execute()&#x27; on to request the next
381 page. Returns None if there are no more items in the collection.
382 </pre>
383 </div>
384
385 <div class="method">
386 <code class="details" id="lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</code>
387 <pre>Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.
388
389 Args:
390 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. Email addresses need to adhere to [name guidelines for users and groups](https://support.google.com/a/answer/9193374). 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`.
391 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}`.
392 x__xgafv: string, V1 error format.
393 Allowed values
394 1 - v1 error format
395 2 - v2 error format
396
397 Returns:
398 An object of the form:
399
400 { # The response message for GroupsService.LookupGroupName.
401 &quot;name&quot;: &quot;A String&quot;, # The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Group`.
402 }</pre>
403 </div>
404
405 <div class="method">
406 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
407 <pre>Updates a `Group`.
408
409 Args:
410 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)
411 body: object, The request body.
412 The object takes the form of:
413
414 { # 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.
415 &quot;additionalGroupKeys&quot;: [ # Output only. Additional group keys associated with the Group.
416 { # 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.
417 &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. Email addresses need to adhere to [name guidelines for users and groups](https://support.google.com/a/answer/9193374). 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`.
418 &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}`.
419 },
420 ],
421 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
422 &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.
423 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
424 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
425 &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 500 dynamic groups.
426 { # Defines a query on a resource.
427 &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;)`
428 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
429 },
430 ],
431 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
432 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
433 &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.
434 },
435 },
436 &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. The `EntityKey` of the `Group`.
437 &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. Email addresses need to adhere to [name guidelines for users and groups](https://support.google.com/a/answer/9193374). 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`.
438 &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}`.
439 },
440 &quot;labels&quot;: { # Required. One or more label entries that apply to the Group. 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. Google Groups can be [locked](https://support.google.com/a?p=locked-groups). To lock a group, add a label with a key of `cloudidentity.googleapis.com/groups.locked` and an empty value. Doing so locks the group. To unlock the group, remove this label.
441 &quot;a_key&quot;: &quot;A String&quot;,
442 },
443 &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}`.
444 &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](https://support.google.com/a/answer/9039510) or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793)
445 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
446 }
447
448 updateMask: string, Required. The names of fields to update. May only contain the following field names: `display_name`, `description`, `labels`.
449 x__xgafv: string, V1 error format.
450 Allowed values
451 1 - v1 error format
452 2 - v2 error format
453
454 Returns:
455 An object of the form:
456
457 { # This resource represents a long-running operation that is the result of a network API call.
458 &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.
459 &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.
460 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
461 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
462 {
463 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
464 },
465 ],
466 &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.
467 },
468 &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.
469 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
470 },
471 &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}`.
472 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
473 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
474 },
475 }</pre>
476 </div>
477
478 <div class="method">
479 <code class="details" id="search">search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)</code>
480 <pre>Searches for `Group` resources matching a specified query.
481
482 Args:
483 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`.
484 pageToken: string, The `next_page_token` value returned from a previous search request, if any.
485 query: string, Required. The search query. * Must be specified in [Common Expression Language](https://opensource.google/projects/cel). * Must contain equality operators on the parent, e.g. `parent == &#x27;customers/{customer_id}&#x27;`. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793) * Can contain optional inclusion operators on `labels` such as `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27; in labels`). * Can contain an optional equality operator on `domain_name`. e.g. `domain_name == &#x27;examplepetstore.com&#x27;` * Can contain optional `startsWith/contains/equality` operators on `group_key`, e.g. `group_key.startsWith(&#x27;dev&#x27;)`, `group_key.contains(&#x27;dev&#x27;), group_key == &#x27;[email protected]&#x27;` * Can contain optional `startsWith/contains/equality` operators on `display_name`, such as `display_name.startsWith(&#x27;dev&#x27;)` , `display_name.contains(&#x27;dev&#x27;)`, `display_name == &#x27;dev&#x27;`
486 view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
487 Allowed values
488 VIEW_UNSPECIFIED - Default. Should not be used.
489 BASIC - Only basic resource information is returned.
490 FULL - All resource information is returned.
491 x__xgafv: string, V1 error format.
492 Allowed values
493 1 - v1 error format
494 2 - v2 error format
495
496 Returns:
497 An object of the form:
498
499 { # The response message for GroupsService.SearchGroups.
500 &quot;groups&quot;: [ # The `Group` resources that match the search query.
501 { # 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.
502 &quot;additionalGroupKeys&quot;: [ # Output only. Additional group keys associated with the Group.
503 { # 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.
504 &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. Email addresses need to adhere to [name guidelines for users and groups](https://support.google.com/a/answer/9193374). 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`.
505 &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}`.
506 },
507 ],
508 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
509 &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.
510 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
511 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
512 &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 500 dynamic groups.
513 { # Defines a query on a resource.
514 &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;)`
515 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
516 },
517 ],
518 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
519 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
520 &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.
521 },
522 },
523 &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. The `EntityKey` of the `Group`.
524 &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. Email addresses need to adhere to [name guidelines for users and groups](https://support.google.com/a/answer/9193374). 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`.
525 &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}`.
526 },
527 &quot;labels&quot;: { # Required. One or more label entries that apply to the Group. 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. Google Groups can be [locked](https://support.google.com/a?p=locked-groups). To lock a group, add a label with a key of `cloudidentity.googleapis.com/groups.locked` and an empty value. Doing so locks the group. To unlock the group, remove this label.
528 &quot;a_key&quot;: &quot;A String&quot;,
529 },
530 &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}`.
531 &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](https://support.google.com/a/answer/9039510) or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793)
532 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
533 },
534 ],
535 &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.
536 }</pre>
537 </div>
538
539 <div class="method">
540 <code class="details" id="search_next">search_next()</code>
541 <pre>Retrieves the next page of results.
542
543 Args:
544 previous_request: The request for the previous page. (required)
545 previous_response: The response from the request for the previous page. (required)
546
547 Returns:
548 A request object that you can call &#x27;execute()&#x27; on to request the next
549 page. Returns None if there are no more items in the collection.
550 </pre>
551 </div>
552
553 <div class="method">
554 <code class="details" id="updateSecuritySettings">updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None)</code>
555 <pre>Update Security Settings
556
557 Args:
558 name: string, Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`. (required)
559 body: object, The request body.
560 The object takes the form of:
561
562 { # The definition of security settings.
563 &quot;memberRestriction&quot;: { # The definition of MemberRestriction # The Member Restriction value
564 &quot;evaluation&quot;: { # The evaluated state of this restriction. # The evaluated state of this restriction on a group.
565 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
566 },
567 &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`
568 },
569 &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`.
570 }
571
572 updateMask: string, Required. The fully-qualified names of fields to update. May only contain the following field: `member_restriction.query`.
573 x__xgafv: string, V1 error format.
574 Allowed values
575 1 - v1 error format
576 2 - v2 error format
577
578 Returns:
579 An object of the form:
580
581 { # This resource represents a long-running operation that is the result of a network API call.
582 &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.
583 &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.
584 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
585 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
586 {
587 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
588 },
589 ],
590 &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.
591 },
592 &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.
593 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
594 },
595 &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}`.
596 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
597 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
598 },
599 }</pre>
600 </div>
601
602 </body></html>