Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / cloudidentity_v1beta1.groups.html
blob: 131c83a00eac921346c8bd974e6acaec314b87a8 [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]83 <code><a href="#create">create(body=None, initialGroupConfig=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Creates a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="toc_element">
86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87<p class="firstline">Deletes a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90<p class="firstline">Retrieves a `Group`.</p>
91<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]92 <code><a href="#list">list(view=None, pageToken=None, parent=None, pageSize=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93<p class="firstline">Lists the `Group`s under a customer or namespace.</p>
94<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]98 <code><a href="#lookup">lookup(groupKey_namespace=None, groupKey_id=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99<p class="firstline">Looks up the [resource</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
102<p class="firstline">Updates a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]104 <code><a href="#search">search(query=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]105<p class="firstline">Searches for `Group`s matching a specified query.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106<p class="toc_element">
107 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
108<p class="firstline">Retrieves the next page of results.</p>
109<h3>Method Details</h3>
110<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]111 <code class="details" id="create">create(body=None, initialGroupConfig=None, x__xgafv=None)</code>
112 <pre>Creates a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113
114Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 The object takes the form of:
117
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]118{ # A group within the Cloud Identity Groups API.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]119 #
120 # A `Group` is a collection of entities, where each entity is either a user,
121 # another group or a service account.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]122 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
123 #
124 # An entity can represent either a group with an optional `namespace` or a user
125 # without a `namespace`. The combination of `id` and `namespace` must be
126 # unique; however, the same `id` can be used with different `namespace`s.
127 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
128 #
129 # For Google-managed entities, the `id` must be the email address of an
130 # existing group or user.
131 #
132 # For external-identity-mapped entities, the `id` must be a string conforming
133 # to the Identity Source&#x27;s requirements.
134 #
135 # Must be unique within a `namespace`.
136 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
137 #
138 # If not specified, the `EntityKey` represents a Google-managed entity such
139 # as a Google user or a Google Group.
140 #
141 # If specified, the `EntityKey` represents an external-identity-mapped group.
142 # The namespace must correspond to an identity source created in Admin
143 # Console and must be in the form of `identitysources/{identity_source_id}.
144 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]145 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
146 { # A unique identifier for an entity in the Cloud Identity Groups API.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]147 #
148 # An entity can represent either a group with an optional `namespace` or a user
149 # without a `namespace`. The combination of `id` and `namespace` must be
150 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]151 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]152 #
153 # For Google-managed entities, the `id` must be the email address of an
154 # existing group or user.
155 #
156 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]157 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]158 #
159 # Must be unique within a `namespace`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]160 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]162 # If not specified, the `EntityKey` represents a Google-managed entity such
163 # as a Google user or a Google Group.
164 #
165 # If specified, the `EntityKey` represents an external-identity-mapped group.
166 # The namespace must correspond to an identity source created in Admin
167 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]168 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]169 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]170 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
171 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]172 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]173 # Must not be longer than 4,096 characters.
174 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
175 # the `Group`.
176 #
177 # Shall be of the form `groups/{group_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]178 &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
179 #
180 # Must not contain more than one entry. Must contain the entry
181 # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
182 # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
183 # external-identity-mapped group.
184 &quot;a_key&quot;: &quot;A String&quot;,
185 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]186 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
187 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
188 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
189 # Cloud Identity resource hierarchy.
190 #
191 # Must be of the form `identitysources/{identity_source_id}` for external-
192 # identity-mapped groups or `customers/{customer_id}` for Google Groups.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]193}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]195 initialGroupConfig: string, Required. The initial configuration option for the `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 x__xgafv: string, V1 error format.
197 Allowed values
198 1 - v1 error format
199 2 - v2 error format
200
201Returns:
202 An object of the form:
203
204 { # This resource represents a long-running operation that is the result of a
205 # network API call.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]206 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
207 # originally returns it. If you use the default HTTP mapping, the
208 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]209 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
210 # different programming environments, including REST APIs and RPC APIs. It is
211 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
212 # three pieces of data: error code, error message, and error details.
213 #
214 # You can find out more about this error model and how to work with it in the
215 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]216 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]217 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
218 # message types for APIs to use.
219 {
220 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
221 },
222 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]223 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
224 # user-facing error message should be localized and sent in the
225 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]226 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]227 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
228 # contains progress information and common metadata such as create time.
229 # Some services might not provide such metadata. Any method that returns a
230 # long-running operation should document the metadata type, if any.
231 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
232 },
233 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]234 # method returns no data on success, such as `Delete`, the response is
235 # `google.protobuf.Empty`. If the original method is standard
236 # `Get`/`Create`/`Update`, the response should be the resource. For other
237 # methods, the response should have the type `XxxResponse`, where `Xxx`
238 # is the original method name. For example, if the original method name
239 # is `TakeSnapshot()`, the inferred response type is
240 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]241 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]242 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]243 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
244 # If `true`, the operation is completed, and either `error` or `response` is
245 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246 }</pre>
247</div>
248
249<div class="method">
250 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]251 <pre>Deletes a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252
253Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]254 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of
255the `Group` to retrieve.
256
257Must be of the form `groups/{group_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]258 x__xgafv: string, V1 error format.
259 Allowed values
260 1 - v1 error format
261 2 - v2 error format
262
263Returns:
264 An object of the form:
265
266 { # This resource represents a long-running operation that is the result of a
267 # network API call.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]268 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
269 # originally returns it. If you use the default HTTP mapping, the
270 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]271 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
272 # different programming environments, including REST APIs and RPC APIs. It is
273 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
274 # three pieces of data: error code, error message, and error details.
275 #
276 # You can find out more about this error model and how to work with it in the
277 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]278 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]279 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
280 # message types for APIs to use.
281 {
282 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
283 },
284 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]285 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
286 # user-facing error message should be localized and sent in the
287 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]288 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]289 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
290 # contains progress information and common metadata such as create time.
291 # Some services might not provide such metadata. Any method that returns a
292 # long-running operation should document the metadata type, if any.
293 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
294 },
295 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]296 # method returns no data on success, such as `Delete`, the response is
297 # `google.protobuf.Empty`. If the original method is standard
298 # `Get`/`Create`/`Update`, the response should be the resource. For other
299 # methods, the response should have the type `XxxResponse`, where `Xxx`
300 # is the original method name. For example, if the original method name
301 # is `TakeSnapshot()`, the inferred response type is
302 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]303 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]304 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]305 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
306 # If `true`, the operation is completed, and either `error` or `response` is
307 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]308 }</pre>
309</div>
310
311<div class="method">
312 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]313 <pre>Retrieves a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]314
315Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]316 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of
317the `Group` to retrieve.
318
319Must be of the form `groups/{group_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320 x__xgafv: string, V1 error format.
321 Allowed values
322 1 - v1 error format
323 2 - v2 error format
324
325Returns:
326 An object of the form:
327
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]328 { # A group within the Cloud Identity Groups API.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]329 #
330 # A `Group` is a collection of entities, where each entity is either a user,
331 # another group or a service account.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]332 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
333 #
334 # An entity can represent either a group with an optional `namespace` or a user
335 # without a `namespace`. The combination of `id` and `namespace` must be
336 # unique; however, the same `id` can be used with different `namespace`s.
337 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
338 #
339 # For Google-managed entities, the `id` must be the email address of an
340 # existing group or user.
341 #
342 # For external-identity-mapped entities, the `id` must be a string conforming
343 # to the Identity Source&#x27;s requirements.
344 #
345 # Must be unique within a `namespace`.
346 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
347 #
348 # If not specified, the `EntityKey` represents a Google-managed entity such
349 # as a Google user or a Google Group.
350 #
351 # If specified, the `EntityKey` represents an external-identity-mapped group.
352 # The namespace must correspond to an identity source created in Admin
353 # Console and must be in the form of `identitysources/{identity_source_id}.
354 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]355 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
356 { # A unique identifier for an entity in the Cloud Identity Groups API.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]357 #
358 # An entity can represent either a group with an optional `namespace` or a user
359 # without a `namespace`. The combination of `id` and `namespace` must be
360 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]361 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]362 #
363 # For Google-managed entities, the `id` must be the email address of an
364 # existing group or user.
365 #
366 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]367 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]368 #
369 # Must be unique within a `namespace`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]370 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]371 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]372 # If not specified, the `EntityKey` represents a Google-managed entity such
373 # as a Google user or a Google Group.
374 #
375 # If specified, the `EntityKey` represents an external-identity-mapped group.
376 # The namespace must correspond to an identity source created in Admin
377 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]378 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]379 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]380 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
381 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]382 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]383 # Must not be longer than 4,096 characters.
384 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
385 # the `Group`.
386 #
387 # Shall be of the form `groups/{group_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]388 &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
389 #
390 # Must not contain more than one entry. Must contain the entry
391 # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
392 # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
393 # external-identity-mapped group.
394 &quot;a_key&quot;: &quot;A String&quot;,
395 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]396 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
397 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
398 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
399 # Cloud Identity resource hierarchy.
400 #
401 # Must be of the form `identitysources/{identity_source_id}` for external-
402 # identity-mapped groups or `customers/{customer_id}` for Google Groups.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]403 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]404</div>
405
406<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]407 <code class="details" id="list">list(view=None, pageToken=None, parent=None, pageSize=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]408 <pre>Lists the `Group`s under a customer or namespace.
409
410Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]411 view: string, The level of detail to be returned.
412
413If unspecified, defaults to `View.BASIC`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]414 pageToken: string, The `next_page_token` value returned from a previous list request, if any.
415 parent: string, Required. The parent resource under which to list all `Group`s.
416
417Must be of the form `identitysources/{identity_source_id}` for external-
418identity-mapped groups or `customers/{customer_id}` for Google Groups.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]419 pageSize: integer, The maximum number of results to return.
420
421Note that the number of results returned may be less than this value even
422if there are more available results. To fetch all results, clients must
423continue calling this method repeatedly until the response no longer
424contains a `next_page_token`.
425
426If unspecified, defaults to 200 for `View.BASIC` and to 50 for `View.FULL`.
427
428Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]429 x__xgafv: string, V1 error format.
430 Allowed values
431 1 - v1 error format
432 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]433
434Returns:
435 An object of the form:
436
437 { # The response message for GroupsService.ListGroups.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]438 &quot;nextPageToken&quot;: &quot;A String&quot;, # A continuation token to retrieve the next page of results, or empty if
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]439 # there are no more results available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]440 &quot;groups&quot;: [ # The `Group`s under the specified `parent`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]441 { # A group within the Cloud Identity Groups API.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]442 #
443 # A `Group` is a collection of entities, where each entity is either a user,
444 # another group or a service account.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]445 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
446 #
447 # An entity can represent either a group with an optional `namespace` or a user
448 # without a `namespace`. The combination of `id` and `namespace` must be
449 # unique; however, the same `id` can be used with different `namespace`s.
450 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
451 #
452 # For Google-managed entities, the `id` must be the email address of an
453 # existing group or user.
454 #
455 # For external-identity-mapped entities, the `id` must be a string conforming
456 # to the Identity Source&#x27;s requirements.
457 #
458 # Must be unique within a `namespace`.
459 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
460 #
461 # If not specified, the `EntityKey` represents a Google-managed entity such
462 # as a Google user or a Google Group.
463 #
464 # If specified, the `EntityKey` represents an external-identity-mapped group.
465 # The namespace must correspond to an identity source created in Admin
466 # Console and must be in the form of `identitysources/{identity_source_id}.
467 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]468 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
469 { # A unique identifier for an entity in the Cloud Identity Groups API.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]470 #
471 # An entity can represent either a group with an optional `namespace` or a user
472 # without a `namespace`. The combination of `id` and `namespace` must be
473 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]474 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]475 #
476 # For Google-managed entities, the `id` must be the email address of an
477 # existing group or user.
478 #
479 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]480 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]481 #
482 # Must be unique within a `namespace`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]483 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]484 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]485 # If not specified, the `EntityKey` represents a Google-managed entity such
486 # as a Google user or a Google Group.
487 #
488 # If specified, the `EntityKey` represents an external-identity-mapped group.
489 # The namespace must correspond to an identity source created in Admin
490 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]491 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]492 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]493 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
494 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]495 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]496 # Must not be longer than 4,096 characters.
497 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
498 # the `Group`.
499 #
500 # Shall be of the form `groups/{group_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]501 &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
502 #
503 # Must not contain more than one entry. Must contain the entry
504 # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
505 # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
506 # external-identity-mapped group.
507 &quot;a_key&quot;: &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]508 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]509 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
510 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
511 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
512 # Cloud Identity resource hierarchy.
513 #
514 # Must be of the form `identitysources/{identity_source_id}` for external-
515 # identity-mapped groups or `customers/{customer_id}` for Google Groups.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]516 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]517 ],
518 }</pre>
519</div>
520
521<div class="method">
522 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
523 <pre>Retrieves the next page of results.
524
525Args:
526 previous_request: The request for the previous page. (required)
527 previous_response: The response from the request for the previous page. (required)
528
529Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]530 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]531 page. Returns None if there are no more items in the collection.
532 </pre>
533</div>
534
535<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]536 <code class="details" id="lookup">lookup(groupKey_namespace=None, groupKey_id=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]537 <pre>Looks up the [resource
538name](https://cloud.google.com/apis/design/resource_names) of a `Group` by
539its `EntityKey`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]540
541Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]542 groupKey_namespace: string, The namespace in which the entity exists.
543
544If not specified, the `EntityKey` represents a Google-managed entity such
545as a Google user or a Google Group.
546
547If specified, the `EntityKey` represents an external-identity-mapped group.
548The namespace must correspond to an identity source created in Admin
549Console and must be in the form of `identitysources/{identity_source_id}.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]550 groupKey_id: string, The ID of the entity.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]551
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]552For Google-managed entities, the `id` must be the email address of an
553existing group or user.
554
555For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]556to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]557
558Must be unique within a `namespace`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]559 x__xgafv: string, V1 error format.
560 Allowed values
561 1 - v1 error format
562 2 - v2 error format
563
564Returns:
565 An object of the form:
566
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]567 { # The response message for GroupsService.LookupGroupName.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]568 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]569 # the looked-up `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]570 }</pre>
571</div>
572
573<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]574 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
575 <pre>Updates a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]576
577Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]578 name: string, Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
579the `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]580
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]581Shall be of the form `groups/{group_id}`. (required)
582 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]583 The object takes the form of:
584
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]585{ # A group within the Cloud Identity Groups API.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]586 #
587 # A `Group` is a collection of entities, where each entity is either a user,
588 # another group or a service account.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]589 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
590 #
591 # An entity can represent either a group with an optional `namespace` or a user
592 # without a `namespace`. The combination of `id` and `namespace` must be
593 # unique; however, the same `id` can be used with different `namespace`s.
594 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
595 #
596 # For Google-managed entities, the `id` must be the email address of an
597 # existing group or user.
598 #
599 # For external-identity-mapped entities, the `id` must be a string conforming
600 # to the Identity Source&#x27;s requirements.
601 #
602 # Must be unique within a `namespace`.
603 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
604 #
605 # If not specified, the `EntityKey` represents a Google-managed entity such
606 # as a Google user or a Google Group.
607 #
608 # If specified, the `EntityKey` represents an external-identity-mapped group.
609 # The namespace must correspond to an identity source created in Admin
610 # Console and must be in the form of `identitysources/{identity_source_id}.
611 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]612 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
613 { # A unique identifier for an entity in the Cloud Identity Groups API.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]614 #
615 # An entity can represent either a group with an optional `namespace` or a user
616 # without a `namespace`. The combination of `id` and `namespace` must be
617 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]618 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]619 #
620 # For Google-managed entities, the `id` must be the email address of an
621 # existing group or user.
622 #
623 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]624 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]625 #
626 # Must be unique within a `namespace`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]627 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]628 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]629 # If not specified, the `EntityKey` represents a Google-managed entity such
630 # as a Google user or a Google Group.
631 #
632 # If specified, the `EntityKey` represents an external-identity-mapped group.
633 # The namespace must correspond to an identity source created in Admin
634 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]635 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]636 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]637 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
638 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]639 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]640 # Must not be longer than 4,096 characters.
641 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
642 # the `Group`.
643 #
644 # Shall be of the form `groups/{group_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]645 &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
646 #
647 # Must not contain more than one entry. Must contain the entry
648 # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
649 # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
650 # external-identity-mapped group.
651 &quot;a_key&quot;: &quot;A String&quot;,
652 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]653 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
654 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
655 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
656 # Cloud Identity resource hierarchy.
657 #
658 # Must be of the form `identitysources/{identity_source_id}` for external-
659 # identity-mapped groups or `customers/{customer_id}` for Google Groups.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]660}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]661
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]662 updateMask: string, Required. The fully-qualified names of fields to update.
663
664May only contain the following fields: `display_name`, `description`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]665 x__xgafv: string, V1 error format.
666 Allowed values
667 1 - v1 error format
668 2 - v2 error format
669
670Returns:
671 An object of the form:
672
673 { # This resource represents a long-running operation that is the result of a
674 # network API call.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]675 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
676 # originally returns it. If you use the default HTTP mapping, the
677 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]678 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
679 # different programming environments, including REST APIs and RPC APIs. It is
680 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
681 # three pieces of data: error code, error message, and error details.
682 #
683 # You can find out more about this error model and how to work with it in the
684 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]685 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]686 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
687 # message types for APIs to use.
688 {
689 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
690 },
691 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]692 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
693 # user-facing error message should be localized and sent in the
694 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]695 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]696 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
697 # contains progress information and common metadata such as create time.
698 # Some services might not provide such metadata. Any method that returns a
699 # long-running operation should document the metadata type, if any.
700 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
701 },
702 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]703 # method returns no data on success, such as `Delete`, the response is
704 # `google.protobuf.Empty`. If the original method is standard
705 # `Get`/`Create`/`Update`, the response should be the resource. For other
706 # methods, the response should have the type `XxxResponse`, where `Xxx`
707 # is the original method name. For example, if the original method name
708 # is `TakeSnapshot()`, the inferred response type is
709 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]710 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]711 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]712 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
713 # If `true`, the operation is completed, and either `error` or `response` is
714 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]715 }</pre>
716</div>
717
718<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]719 <code class="details" id="search">search(query=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]720 <pre>Searches for `Group`s matching a specified query.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]721
722Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]723 query: string, Required. The search query.
724
725Must be specified in [Common Expression
726Language](https://opensource.google/projects/cel). May only contain
727equality operators on the parent and inclusion operators on labels (e.g.,
728`parent == &#x27;customers/{customer_id}&#x27; &amp;&amp;
729&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27; in labels`).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]730 pageSize: integer, The maximum number of results to return.
731
732Note that the number of results returned may be less than this value even
733if there are more available results. To fetch all results, clients must
734continue calling this method repeatedly until the response no longer
735contains a `next_page_token`.
736
737If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for
738`GroupView.FULL`.
739
740Must not be greater than 1000 for `GroupView.BASIC` or 500 for
741`GroupView.FULL`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]742 pageToken: string, The `next_page_token` value returned from a previous search request, if
743any.
744 view: string, The level of detail to be returned.
745
746If unspecified, defaults to `View.BASIC`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]747 x__xgafv: string, V1 error format.
748 Allowed values
749 1 - v1 error format
750 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]751
752Returns:
753 An object of the form:
754
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]755 { # The response message for GroupsService.SearchGroups.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]756 &quot;groups&quot;: [ # The `Group`s that match the search query.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]757 { # A group within the Cloud Identity Groups API.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]758 #
759 # A `Group` is a collection of entities, where each entity is either a user,
760 # another group or a service account.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]761 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
762 #
763 # An entity can represent either a group with an optional `namespace` or a user
764 # without a `namespace`. The combination of `id` and `namespace` must be
765 # unique; however, the same `id` can be used with different `namespace`s.
766 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
767 #
768 # For Google-managed entities, the `id` must be the email address of an
769 # existing group or user.
770 #
771 # For external-identity-mapped entities, the `id` must be a string conforming
772 # to the Identity Source&#x27;s requirements.
773 #
774 # Must be unique within a `namespace`.
775 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
776 #
777 # If not specified, the `EntityKey` represents a Google-managed entity such
778 # as a Google user or a Google Group.
779 #
780 # If specified, the `EntityKey` represents an external-identity-mapped group.
781 # The namespace must correspond to an identity source created in Admin
782 # Console and must be in the form of `identitysources/{identity_source_id}.
783 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]784 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
785 { # A unique identifier for an entity in the Cloud Identity Groups API.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]786 #
787 # An entity can represent either a group with an optional `namespace` or a user
788 # without a `namespace`. The combination of `id` and `namespace` must be
789 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]790 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]791 #
792 # For Google-managed entities, the `id` must be the email address of an
793 # existing group or user.
794 #
795 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]796 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]797 #
798 # Must be unique within a `namespace`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]799 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]800 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]801 # If not specified, the `EntityKey` represents a Google-managed entity such
802 # as a Google user or a Google Group.
803 #
804 # If specified, the `EntityKey` represents an external-identity-mapped group.
805 # The namespace must correspond to an identity source created in Admin
806 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]807 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]808 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]809 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
810 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]811 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]812 # Must not be longer than 4,096 characters.
813 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
814 # the `Group`.
815 #
816 # Shall be of the form `groups/{group_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]817 &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
818 #
819 # Must not contain more than one entry. Must contain the entry
820 # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
821 # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
822 # external-identity-mapped group.
823 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]824 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]825 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
826 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
827 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
828 # Cloud Identity resource hierarchy.
829 #
830 # Must be of the form `identitysources/{identity_source_id}` for external-
831 # identity-mapped groups or `customers/{customer_id}` for Google Groups.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]832 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]833 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]834 &quot;nextPageToken&quot;: &quot;A String&quot;, # A continuation token to retrieve the next page of results, or empty if
835 # there are no more results available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]836 }</pre>
837</div>
838
839<div class="method">
840 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
841 <pre>Retrieves the next page of results.
842
843Args:
844 previous_request: The request for the previous page. (required)
845 previous_response: The response from the request for the previous page. (required)
846
847Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]848 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]849 page. Returns None if there are no more items in the collection.
850 </pre>
851</div>
852
853</body></html>