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