blob: 18dd332bef1b2616355eaecea3235d7ad87f0ffa [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_v1beta1.html">Cloud Identity API</a> . <a href="cloudidentity_v1beta1.groups.html">groups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="cloudidentity_v1beta1.groups.memberships.html">memberships()</a></code>
79</p>
80<p class="firstline">Returns the memberships Resource.</p>
81
82<p class="toc_element">
Dmitry 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">
Dan O'Mearadd494642020-05-01 07:42:23 -070086 <code><a href="#create">create(body=None, initialGroupConfig=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Creates a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -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>
Dan O'Mearadd494642020-05-01 07:42:23 -070093<p class="firstline">Retrieves a `Group`.</p>
94<p class="toc_element">
yoshi-code-bot9d638832021-10-05 00:20:14 -070095 <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>
Dan O'Mearadd494642020-05-01 07:42:23 -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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103<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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -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>
108<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-bot9d638832021-10-05 00:20:14 -0700115<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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700125 <code class="details" id="create">create(body=None, initialGroupConfig=None, x__xgafv=None)</code>
126 <pre>Creates a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700127
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
Dmitry Frenkel3e17f892020-10-06 16:46:05 -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 Botcc94ec82021-01-15 07:10:04 -0800133 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
134 { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800135 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700136 &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_id}`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800137 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800138 ],
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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800143 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800144 { # Defines a query on a resource.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700145 &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 Automation Botcc94ec82021-01-15 07:10:04 -0800146 &quot;resourceType&quot;: &quot;A String&quot;,
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. Immutable. The `EntityKey` of the `Group`.
155 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700156 &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_id}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800157 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700158 &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 -0800159 &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_id}`.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700162 &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_id}` 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;).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700163 &quot;posixGroups&quot;: [ # Optional. The POSIX groups associated with the `Group`.
164 { # POSIX Group definition to represent a group in a POSIX compliant system.
165 &quot;gid&quot;: &quot;A String&quot;, # GID of the POSIX group.
166 &quot;name&quot;: &quot;A String&quot;, # Name of the POSIX group.
167 &quot;systemId&quot;: &quot;A String&quot;, # System identifier for which group name and gid apply to. If not specified it will default to empty value.
168 },
169 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800170 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
171}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700172
Dan O'Mearadd494642020-05-01 07:42:23 -0700173 initialGroupConfig: string, Required. The initial configuration option for the `Group`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700174 Allowed values
175 INITIAL_GROUP_CONFIG_UNSPECIFIED - Default. Should not be used.
176 WITH_INITIAL_OWNER - The end user making the request will be added as the initial owner of the `Group`.
177 EMPTY - An empty group is created without any initial owners. This can only be used by admins of the domain.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700178 x__xgafv: string, V1 error format.
179 Allowed values
180 1 - v1 error format
181 2 - v2 error format
182
183Returns:
184 An object of the form:
185
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700186 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800187 &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.
188 &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.
189 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
190 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
191 {
192 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
193 },
194 ],
195 &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.
196 },
197 &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.
198 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
199 },
200 &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}`.
201 &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`.
202 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
203 },
204}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700205</div>
206
207<div class="method">
208 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700209 <pre>Deletes a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700210
211Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700212 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700213 x__xgafv: string, V1 error format.
214 Allowed values
215 1 - v1 error format
216 2 - v2 error format
217
218Returns:
219 An object of the form:
220
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700221 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800222 &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.
223 &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.
224 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
225 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
226 {
227 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
228 },
229 ],
230 &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.
231 },
232 &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.
233 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
234 },
235 &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}`.
236 &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`.
237 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
238 },
239}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700240</div>
241
242<div class="method">
243 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700244 <pre>Retrieves a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700245
246Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700247 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700248 x__xgafv: string, V1 error format.
249 Allowed values
250 1 - v1 error format
251 2 - v2 error format
252
253Returns:
254 An object of the form:
255
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700256 { # 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 -0800257 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
258 { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s.
259 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700260 &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_id}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800261 },
262 ],
263 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
264 &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.
265 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
266 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800267 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800268 { # Defines a query on a resource.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700269 &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 Automation Botcc94ec82021-01-15 07:10:04 -0800270 &quot;resourceType&quot;: &quot;A String&quot;,
271 },
272 ],
273 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
274 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
275 &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.
276 },
277 },
278 &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`.
279 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700280 &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_id}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800281 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700282 &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 -0800283 &quot;a_key&quot;: &quot;A String&quot;,
284 },
285 &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_id}`.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700286 &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_id}` 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;).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700287 &quot;posixGroups&quot;: [ # Optional. The POSIX groups associated with the `Group`.
288 { # POSIX Group definition to represent a group in a POSIX compliant system.
289 &quot;gid&quot;: &quot;A String&quot;, # GID of the POSIX group.
290 &quot;name&quot;: &quot;A String&quot;, # Name of the POSIX group.
291 &quot;systemId&quot;: &quot;A String&quot;, # System identifier for which group name and gid apply to. If not specified it will default to empty value.
292 },
293 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800294 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
295}</pre>
296</div>
297
298<div class="method">
yoshi-code-bot9d638832021-10-05 00:20:14 -0700299 <code class="details" id="getSecuritySettings">getSecuritySettings(name, readMask=None, x__xgafv=None)</code>
300 <pre>Get Security Settings
301
302Args:
303 name: string, Required. The security settings to retrieve. Format: `groups/{group_id}/securitySettings` (required)
304 readMask: string, Field-level read mask of which fields to return. &quot;*&quot; returns all fields. If not specified, all fields will be returned. May only contain the following field: `member_restriction`.
305 x__xgafv: string, V1 error format.
306 Allowed values
307 1 - v1 error format
308 2 - v2 error format
309
310Returns:
311 An object of the form:
312
313 { # The definiion of security settings.
314 &quot;memberRestriction&quot;: { # The definition of MemberRestriction # The Member Restriction value
315 &quot;evaluation&quot;: { # The evaluated state of this restriction. # The evaluated state of this restriction on a group.
316 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
317 },
318 &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`
319 },
320 &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`.
321}</pre>
322</div>
323
324<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800325 <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 -0700326 <pre>Lists the `Group` resources under a customer or namespace.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800327
328Args:
329 pageSize: integer, The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `View.BASIC` and to 50 for `View.FULL`. Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`.
330 pageToken: string, The `next_page_token` value returned from a previous list request, if any.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700331 parent: string, Required. The parent resource under which to list all `Group` resources. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800332 view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
333 Allowed values
334 VIEW_UNSPECIFIED - Default. Should not be used.
335 BASIC - Only basic resource information is returned.
336 FULL - All resource information is returned.
337 x__xgafv: string, V1 error format.
338 Allowed values
339 1 - v1 error format
340 2 - v2 error format
341
342Returns:
343 An object of the form:
344
345 { # The response message for GroupsService.ListGroups.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700346 &quot;groups&quot;: [ # The `Group` resources under the specified `parent`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800347 { # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.
348 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
349 { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s.
350 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700351 &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_id}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800352 },
353 ],
354 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800355 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800356 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800357 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800358 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800359 { # Defines a query on a resource.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700360 &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 Automation Bot0bf565c2020-12-09 08:56:03 -0800361 &quot;resourceType&quot;: &quot;A String&quot;,
362 },
363 ],
364 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
365 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
366 &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.
367 },
368 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800369 &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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800370 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700371 &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_id}`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800372 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700373 &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 -0800374 &quot;a_key&quot;: &quot;A String&quot;,
375 },
376 &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_id}`.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700377 &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_id}` 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;).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700378 &quot;posixGroups&quot;: [ # Optional. The POSIX groups associated with the `Group`.
379 { # POSIX Group definition to represent a group in a POSIX compliant system.
380 &quot;gid&quot;: &quot;A String&quot;, # GID of the POSIX group.
381 &quot;name&quot;: &quot;A String&quot;, # Name of the POSIX group.
382 &quot;systemId&quot;: &quot;A String&quot;, # System identifier for which group name and gid apply to. If not specified it will default to empty value.
383 },
384 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800385 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
386 },
387 ],
388 &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.
389}</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700390</div>
391
392<div class="method">
393 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
394 <pre>Retrieves the next page of results.
395
396Args:
397 previous_request: The request for the previous page. (required)
398 previous_response: The response from the request for the previous page. (required)
399
400Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700401 A request object that you can call &#x27;execute()&#x27; on to request the next
Dan O'Mearadd494642020-05-01 07:42:23 -0700402 page. Returns None if there are no more items in the collection.
403 </pre>
404</div>
405
406<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800407 <code class="details" id="lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700408 <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 -0700409
410Args:
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800411 groupKey_id: string, The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700412 groupKey_namespace: string, The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700413 x__xgafv: string, V1 error format.
414 Allowed values
415 1 - v1 error format
416 2 - v2 error format
417
418Returns:
419 An object of the form:
420
Dan O'Mearadd494642020-05-01 07:42:23 -0700421 { # The response message for GroupsService.LookupGroupName.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800422 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Group`.
423}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700424</div>
425
426<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700427 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
428 <pre>Updates a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700429
430Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700431 name: string, Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700432 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700433 The object takes the form of:
434
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700435{ # 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 -0800436 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
437 { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800438 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700439 &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_id}`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800440 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800441 ],
442 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
443 &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.
444 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
445 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800446 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800447 { # Defines a query on a resource.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700448 &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 Automation Botcc94ec82021-01-15 07:10:04 -0800449 &quot;resourceType&quot;: &quot;A String&quot;,
450 },
451 ],
452 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
453 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
454 &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.
455 },
456 },
457 &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`.
458 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700459 &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_id}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800460 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700461 &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 -0800462 &quot;a_key&quot;: &quot;A String&quot;,
463 },
464 &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_id}`.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700465 &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_id}` 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;).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700466 &quot;posixGroups&quot;: [ # Optional. The POSIX groups associated with the `Group`.
467 { # POSIX Group definition to represent a group in a POSIX compliant system.
468 &quot;gid&quot;: &quot;A String&quot;, # GID of the POSIX group.
469 &quot;name&quot;: &quot;A String&quot;, # Name of the POSIX group.
470 &quot;systemId&quot;: &quot;A String&quot;, # System identifier for which group name and gid apply to. If not specified it will default to empty value.
471 },
472 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800473 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
474}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700475
yoshi-code-bote5e87b12021-09-14 00:22:34 -0700476 updateMask: string, Required. The names of fields to update. May only contain the following field names: `display_name`, `description`, `labels`, `dynamic_group_metadata`, `posix_groups`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700477 x__xgafv: string, V1 error format.
478 Allowed values
479 1 - v1 error format
480 2 - v2 error format
481
482Returns:
483 An object of the form:
484
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700485 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800486 &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.
487 &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.
488 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
489 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
490 {
491 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
492 },
493 ],
494 &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.
495 },
496 &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.
497 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
498 },
499 &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}`.
500 &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`.
501 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
502 },
503}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700504</div>
505
506<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800507 <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 -0700508 <pre>Searches for `Group` resources matching a specified query.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700509
510Args:
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800511 pageSize: integer, The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700512 pageToken: string, The `next_page_token` value returned from a previous search request, if any.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700513 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_id}&#x27; &amp;&amp; &#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27; in labels`). The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700514 view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
515 Allowed values
516 BASIC - Default. Only basic resource information is returned.
517 FULL - All resource information is returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700518 x__xgafv: string, V1 error format.
519 Allowed values
520 1 - v1 error format
521 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700522
523Returns:
524 An object of the form:
525
Dan O'Mearadd494642020-05-01 07:42:23 -0700526 { # The response message for GroupsService.SearchGroups.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700527 &quot;groups&quot;: [ # The `Group` resources that match the search query.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800528 { # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.
529 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
530 { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s.
531 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700532 &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_id}`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800533 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800534 ],
535 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
536 &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.
537 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
538 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800539 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800540 { # Defines a query on a resource.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700541 &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 Automation Botcc94ec82021-01-15 07:10:04 -0800542 &quot;resourceType&quot;: &quot;A String&quot;,
543 },
544 ],
545 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
546 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
547 &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.
548 },
549 },
550 &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`.
551 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700552 &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_id}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800553 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700554 &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 -0800555 &quot;a_key&quot;: &quot;A String&quot;,
556 },
557 &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_id}`.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700558 &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_id}` 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;).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700559 &quot;posixGroups&quot;: [ # Optional. The POSIX groups associated with the `Group`.
560 { # POSIX Group definition to represent a group in a POSIX compliant system.
561 &quot;gid&quot;: &quot;A String&quot;, # GID of the POSIX group.
562 &quot;name&quot;: &quot;A String&quot;, # Name of the POSIX group.
563 &quot;systemId&quot;: &quot;A String&quot;, # System identifier for which group name and gid apply to. If not specified it will default to empty value.
564 },
565 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800566 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
567 },
568 ],
569 &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.
570}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700571</div>
572
573<div class="method">
574 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
575 <pre>Retrieves the next page of results.
576
577Args:
578 previous_request: The request for the previous page. (required)
579 previous_response: The response from the request for the previous page. (required)
580
581Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700582 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700583 page. Returns None if there are no more items in the collection.
584 </pre>
585</div>
586
yoshi-code-bot9d638832021-10-05 00:20:14 -0700587<div class="method">
588 <code class="details" id="updateSecuritySettings">updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None)</code>
589 <pre>Update Security Settings
590
591Args:
592 name: string, Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`. (required)
593 body: object, The request body.
594 The object takes the form of:
595
596{ # The definiion of security settings.
597 &quot;memberRestriction&quot;: { # The definition of MemberRestriction # The Member Restriction value
598 &quot;evaluation&quot;: { # The evaluated state of this restriction. # The evaluated state of this restriction on a group.
599 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
600 },
601 &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`
602 },
603 &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`.
604}
605
606 updateMask: string, Required. The fully-qualified names of fields to update. May only contain the following field: `member_restriction.query`.
607 x__xgafv: string, V1 error format.
608 Allowed values
609 1 - v1 error format
610 2 - v2 error format
611
612Returns:
613 An object of the form:
614
615 { # This resource represents a long-running operation that is the result of a network API call.
616 &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.
617 &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.
618 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
619 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
620 {
621 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
622 },
623 ],
624 &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.
625 },
626 &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.
627 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
628 },
629 &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}`.
630 &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`.
631 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
632 },
633}</pre>
634</div>
635
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700636</body></html>