Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / cloudidentity_v1beta1.groups.html
blob: f6cd3d2af8b92d6a895474815d940cd5d6f02741 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<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 -0700[diff] [blame]83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]86 <code><a href="#create">create(body=None, initialGroupConfig=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Creates a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90<p class="firstline">Deletes a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93<p class="firstline">Retrieves a `Group`.</p>
94<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]95 <code><a href="#list">list(pageSize=None, view=None, parent=None, pageToken=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96<p class="firstline">Lists the `Group`s under a customer or namespace.</p>
97<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]101 <code><a href="#lookup">lookup(groupKey_namespace=None, groupKey_id=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]102<p class="firstline">Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
105<p class="firstline">Updates a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]107 <code><a href="#search">search(query=None, pageToken=None, view=None, pageSize=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]108<p class="firstline">Searches for `Group`s matching a specified query.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109<p class="toc_element">
110 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
111<p class="firstline">Retrieves the next page of results.</p>
112<h3>Method Details</h3>
113<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]114 <code class="details" id="close">close()</code>
115 <pre>Close httplib2 connections.</pre>
116</div>
117
118<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]119 <code class="details" id="create">create(body=None, initialGroupConfig=None, x__xgafv=None)</code>
120 <pre>Creates a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121
122Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]123 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 The object takes the form of:
125
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]126{ # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]127 &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`.
128 &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}.
129 &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`.
130 },
131 &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}`.
132 &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.
133 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
134 &quot;queries&quot;: [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported.
135 { # Defines a query on a resource.
136 &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;)`
137 &quot;resourceType&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]138 },
139 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]140 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
141 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
142 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]143 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]144 },
145 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
146 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
147 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
148 { # 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.
149 &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}.
150 &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`.
151 },
152 ],
153 &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.
154 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
155 &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. Examples: {&quot;cloudidentity.googleapis.com/groups.discussion_forum&quot;: &quot;&quot;} or {&quot;system/groups/external&quot;: &quot;&quot;}.
156 &quot;a_key&quot;: &quot;A String&quot;,
157 },
158}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]160 initialGroupConfig: string, Required. The initial configuration option for the `Group`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]161 Allowed values
162 INITIAL_GROUP_CONFIG_UNSPECIFIED - Default. Should not be used.
163 WITH_INITIAL_OWNER - The end user making the request will be added as the initial owner of the `Group`.
164 EMPTY - An empty group is created without any initial owners. This can only be used by admins of the domain.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
169
170Returns:
171 An object of the form:
172
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]173 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]174 &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}`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]175 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]176 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]177 {
178 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
179 },
180 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]181 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]182 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
183 },
184 &quot;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`.
185 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
186 },
187 &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;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.
189 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]190 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]191 }</pre>
192</div>
193
194<div class="method">
195 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]196 <pre>Deletes a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]197
198Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]199 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 -0700[diff] [blame]200 x__xgafv: string, V1 error format.
201 Allowed values
202 1 - v1 error format
203 2 - v2 error format
204
205Returns:
206 An object of the form:
207
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]208 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]209 &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}`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]210 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]211 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]212 {
213 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
214 },
215 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]216 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]217 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
218 },
219 &quot;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`.
220 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
221 },
222 &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;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.
224 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]225 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 }</pre>
227</div>
228
229<div class="method">
230 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]231 <pre>Retrieves a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232
233Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]234 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 -0700[diff] [blame]235 x__xgafv: string, V1 error format.
236 Allowed values
237 1 - v1 error format
238 2 - v2 error format
239
240Returns:
241 An object of the form:
242
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]243 { # 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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]244 &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`.
245 &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}.
246 &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`.
247 },
248 &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}`.
249 &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.
250 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
251 &quot;queries&quot;: [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported.
252 { # Defines a query on a resource.
253 &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;)`
254 &quot;resourceType&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]255 },
256 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]257 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
258 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
259 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]260 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]261 },
262 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
263 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
264 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
265 { # 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.
266 &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}.
267 &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`.
268 },
269 ],
270 &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.
271 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
272 &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. Examples: {&quot;cloudidentity.googleapis.com/groups.discussion_forum&quot;: &quot;&quot;} or {&quot;system/groups/external&quot;: &quot;&quot;}.
273 &quot;a_key&quot;: &quot;A String&quot;,
274 },
275 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]276</div>
277
278<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]279 <code class="details" id="list">list(pageSize=None, view=None, parent=None, pageToken=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]280 <pre>Lists the `Group`s under a customer or namespace.
281
282Args:
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]283 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`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]284 view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
285 Allowed values
286 VIEW_UNSPECIFIED - Default. Should not be used.
287 BASIC - Only basic resource information is returned.
288 FULL - All resource information is returned.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]289 parent: string, Required. The parent resource under which to list all `Group`s. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]290 pageToken: string, The `next_page_token` value returned from a previous list request, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]291 x__xgafv: string, V1 error format.
292 Allowed values
293 1 - v1 error format
294 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]295
296Returns:
297 An object of the form:
298
299 { # The response message for GroupsService.ListGroups.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]300 &quot;groups&quot;: [ # The `Group`s under the specified `parent`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]301 { # 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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]302 &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`.
303 &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}.
304 &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`.
305 },
306 &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}`.
307 &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.
308 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
309 &quot;queries&quot;: [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported.
310 { # Defines a query on a resource.
311 &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;)`
312 &quot;resourceType&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]313 },
314 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]315 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
316 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
317 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]318 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]319 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]320 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
321 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
322 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
323 { # 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.
324 &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}.
325 &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`.
326 },
327 ],
328 &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.
329 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
330 &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. Examples: {&quot;cloudidentity.googleapis.com/groups.discussion_forum&quot;: &quot;&quot;} or {&quot;system/groups/external&quot;: &quot;&quot;}.
331 &quot;a_key&quot;: &quot;A String&quot;,
332 },
333 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]334 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]335 &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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]336 }</pre>
337</div>
338
339<div class="method">
340 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
341 <pre>Retrieves the next page of results.
342
343Args:
344 previous_request: The request for the previous page. (required)
345 previous_response: The response from the request for the previous page. (required)
346
347Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]348 A request object that you can call &#x27;execute()&#x27; on to request the next
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]349 page. Returns None if there are no more items in the collection.
350 </pre>
351</div>
352
353<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]354 <code class="details" id="lookup">lookup(groupKey_namespace=None, groupKey_id=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]355 <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 -0700[diff] [blame]356
357Args:
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]358 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}.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]359 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`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]360 x__xgafv: string, V1 error format.
361 Allowed values
362 1 - v1 error format
363 2 - v2 error format
364
365Returns:
366 An object of the form:
367
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]368 { # The response message for GroupsService.LookupGroupName.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]369 &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`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]370 }</pre>
371</div>
372
373<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]374 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
375 <pre>Updates a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]376
377Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]378 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 -0700[diff] [blame]379 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]380 The object takes the form of:
381
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]382{ # 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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]383 &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`.
384 &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}.
385 &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`.
386 },
387 &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}`.
388 &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.
389 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
390 &quot;queries&quot;: [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported.
391 { # Defines a query on a resource.
392 &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;)`
393 &quot;resourceType&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]394 },
395 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]396 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
397 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
398 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]399 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]400 },
401 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
402 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
403 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
404 { # 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.
405 &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}.
406 &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`.
407 },
408 ],
409 &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.
410 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
411 &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. Examples: {&quot;cloudidentity.googleapis.com/groups.discussion_forum&quot;: &quot;&quot;} or {&quot;system/groups/external&quot;: &quot;&quot;}.
412 &quot;a_key&quot;: &quot;A String&quot;,
413 },
414}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]415
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]416 updateMask: string, Required. The fully-qualified names of fields to update. May only contain the following fields: `display_name`, `description`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]417 x__xgafv: string, V1 error format.
418 Allowed values
419 1 - v1 error format
420 2 - v2 error format
421
422Returns:
423 An object of the form:
424
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]425 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]426 &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}`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]427 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]428 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]429 {
430 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
431 },
432 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]433 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]434 &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.
435 },
436 &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`.
437 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
438 },
439 &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.
440 &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.
441 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]442 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]443 }</pre>
444</div>
445
446<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]447 <code class="details" id="search">search(query=None, pageToken=None, view=None, pageSize=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]448 <pre>Searches for `Group`s matching a specified query.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]449
450Args:
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]451 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`).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]452 pageToken: string, The `next_page_token` value returned from a previous search request, if any.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]453 view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
454 Allowed values
455 BASIC - Default. Only basic resource information is returned.
456 FULL - All resource information is returned.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]457 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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]458 x__xgafv: string, V1 error format.
459 Allowed values
460 1 - v1 error format
461 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]462
463Returns:
464 An object of the form:
465
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]466 { # The response message for GroupsService.SearchGroups.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]467 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]468 &quot;groups&quot;: [ # The `Group`s that match the search query.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]469 { # 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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]470 &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`.
471 &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}.
472 &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`.
473 },
474 &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}`.
475 &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.
476 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
477 &quot;queries&quot;: [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported.
478 { # Defines a query on a resource.
479 &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;)`
480 &quot;resourceType&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]481 },
482 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]483 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
484 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
485 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]486 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]487 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]488 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
489 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
490 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
491 { # 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.
492 &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}.
493 &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`.
494 },
495 ],
496 &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.
497 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
498 &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. Examples: {&quot;cloudidentity.googleapis.com/groups.discussion_forum&quot;: &quot;&quot;} or {&quot;system/groups/external&quot;: &quot;&quot;}.
499 &quot;a_key&quot;: &quot;A String&quot;,
500 },
501 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]502 ],
503 }</pre>
504</div>
505
506<div class="method">
507 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
508 <pre>Retrieves the next page of results.
509
510Args:
511 previous_request: The request for the previous page. (required)
512 previous_response: The response from the request for the previous page. (required)
513
514Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]515 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]516 page. Returns None if there are no more items in the collection.
517 </pre>
518</div>
519
520</body></html>