Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / cloudidentity_v1.groups.html
blob: ebcb5c5b582fe82ef181019631cf95a6681a2dfd [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_v1.html">Cloud Identity API</a> . <a href="cloudidentity_v1.groups.html">groups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="cloudidentity_v1.groups.memberships.html">memberships()</a></code>
79</p>
80<p class="firstline">Returns the memberships Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]83 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84<p class="firstline">Creates a Group.</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes a Group.</p>
88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
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>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93<p class="firstline">Lists groups within a customer or a domain.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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>
97<p class="toc_element">
98 <code><a href="#lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</a></code></p>
99<p class="firstline">Looks up [resource</p>
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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102<p class="firstline">Updates a Group.</p>
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>
105<p class="firstline">Searches for Groups.</p>
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, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 <pre>Creates a Group.
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
118{ # Resource representing a Group.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]119 "updateTime": "A String", # Output only. The time when the Group was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120 # Output only.
121 "displayName": "A String", # The Group's display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]122 "description": "A String", # An extended description to help users determine the purpose of a Group. For
123 # example, you can include information about who should join the Group, the
124 # types of messages to send to the Group, links to FAQs about the Group, or
125 # related Groups. Maximum length is 4,096 characters.
126 "parent": "A String", # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 # hierarchy. Must be set when creating a Group, read-only afterwards.
128 #
129 # Currently allowed types: `identitysources`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]130 "labels": { # Required. `Required`. Labels for Group resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 # For creating Groups under a namespace, set label key to
132 # 'labels/system/groups/external' and label value as empty.
133 "a_key": "A String",
134 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]135 "groupKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 #
137 # Must be set when creating a Group, read-only afterwards.
138 # isolation for IDs. A single ID can be reused across namespaces but the
139 # combination of a namespace and an ID must be unique.
140 "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique
141 # within its namespace.
142 #
143 # Namespaces are currently only created as part of IdentitySource creation
144 # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
145 # created corresponding to every Identity Source `identity_source_id`.
146 "id": "A String", # The ID of the entity within the given namespace. The ID must be unique
147 # within its namespace.
148 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]149 "createTime": "A String", # Output only. The time when the Group was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 # Output only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]151 "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
152 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
153 # assigned to the Group.
154 #
155 # Must be left blank while creating a Group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156}
157
158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
162
163Returns:
164 An object of the form:
165
166 { # This resource represents a long-running operation that is the result of a
167 # network API call.
168 "metadata": { # Service-specific metadata associated with the operation. It typically
169 # contains progress information and common metadata such as create time.
170 # Some services might not provide such metadata. Any method that returns a
171 # long-running operation should document the metadata type, if any.
172 "a_key": "", # Properties of the object. Contains field @type with type URL.
173 },
174 "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.
175 # different programming environments, including REST APIs and RPC APIs. It is
176 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
177 # three pieces of data: error code, error message, and error details.
178 #
179 # You can find out more about this error model and how to work with it in the
180 # [API Design Guide](https://cloud.google.com/apis/design/errors).
181 "message": "A String", # A developer-facing error message, which should be in English. Any
182 # user-facing error message should be localized and sent in the
183 # google.rpc.Status.details field, or localized by the client.
184 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
185 "details": [ # A list of messages that carry the error details. There is a common set of
186 # message types for APIs to use.
187 {
188 "a_key": "", # Properties of the object. Contains field @type with type URL.
189 },
190 ],
191 },
192 "done": True or False, # If the value is `false`, it means the operation is still in progress.
193 # If `true`, the operation is completed, and either `error` or `response` is
194 # available.
195 "response": { # The normal response of the operation in case of success. If the original
196 # method returns no data on success, such as `Delete`, the response is
197 # `google.protobuf.Empty`. If the original method is standard
198 # `Get`/`Create`/`Update`, the response should be the resource. For other
199 # methods, the response should have the type `XxxResponse`, where `Xxx`
200 # is the original method name. For example, if the original method name
201 # is `TakeSnapshot()`, the inferred response type is
202 # `TakeSnapshotResponse`.
203 "a_key": "", # Properties of the object. Contains field @type with type URL.
204 },
205 "name": "A String", # The server-assigned name, which is only unique within the same service that
206 # originally returns it. If you use the default HTTP mapping, the
207 # `name` should be a resource name ending with `operations/{unique_id}`.
208 }</pre>
209</div>
210
211<div class="method">
212 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
213 <pre>Deletes a Group.
214
215Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]216 name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]217Group in the format: `groups/{group_id}`, where `group_id` is the unique ID
218assigned to the Group. (required)
219 x__xgafv: string, V1 error format.
220 Allowed values
221 1 - v1 error format
222 2 - v2 error format
223
224Returns:
225 An object of the form:
226
227 { # This resource represents a long-running operation that is the result of a
228 # network API call.
229 "metadata": { # Service-specific metadata associated with the operation. It typically
230 # contains progress information and common metadata such as create time.
231 # Some services might not provide such metadata. Any method that returns a
232 # long-running operation should document the metadata type, if any.
233 "a_key": "", # Properties of the object. Contains field @type with type URL.
234 },
235 "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.
236 # different programming environments, including REST APIs and RPC APIs. It is
237 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
238 # three pieces of data: error code, error message, and error details.
239 #
240 # You can find out more about this error model and how to work with it in the
241 # [API Design Guide](https://cloud.google.com/apis/design/errors).
242 "message": "A String", # A developer-facing error message, which should be in English. Any
243 # user-facing error message should be localized and sent in the
244 # google.rpc.Status.details field, or localized by the client.
245 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
246 "details": [ # A list of messages that carry the error details. There is a common set of
247 # message types for APIs to use.
248 {
249 "a_key": "", # Properties of the object. Contains field @type with type URL.
250 },
251 ],
252 },
253 "done": True or False, # If the value is `false`, it means the operation is still in progress.
254 # If `true`, the operation is completed, and either `error` or `response` is
255 # available.
256 "response": { # The normal response of the operation in case of success. If the original
257 # method returns no data on success, such as `Delete`, the response is
258 # `google.protobuf.Empty`. If the original method is standard
259 # `Get`/`Create`/`Update`, the response should be the resource. For other
260 # methods, the response should have the type `XxxResponse`, where `Xxx`
261 # is the original method name. For example, if the original method name
262 # is `TakeSnapshot()`, the inferred response type is
263 # `TakeSnapshotResponse`.
264 "a_key": "", # Properties of the object. Contains field @type with type URL.
265 },
266 "name": "A String", # The server-assigned name, which is only unique within the same service that
267 # originally returns it. If you use the default HTTP mapping, the
268 # `name` should be a resource name ending with `operations/{unique_id}`.
269 }</pre>
270</div>
271
272<div class="method">
273 <code class="details" id="get">get(name, x__xgafv=None)</code>
274 <pre>Retrieves a Group.
275
276Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]277 name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]278Group in the format: `groups/{group_id}`, where `group_id` is the unique ID
279assigned to the Group. (required)
280 x__xgafv: string, V1 error format.
281 Allowed values
282 1 - v1 error format
283 2 - v2 error format
284
285Returns:
286 An object of the form:
287
288 { # Resource representing a Group.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]289 "updateTime": "A String", # Output only. The time when the Group was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]290 # Output only.
291 "displayName": "A String", # The Group's display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]292 "description": "A String", # An extended description to help users determine the purpose of a Group. For
293 # example, you can include information about who should join the Group, the
294 # types of messages to send to the Group, links to FAQs about the Group, or
295 # related Groups. Maximum length is 4,096 characters.
296 "parent": "A String", # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]297 # hierarchy. Must be set when creating a Group, read-only afterwards.
298 #
299 # Currently allowed types: `identitysources`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]300 "labels": { # Required. `Required`. Labels for Group resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]301 # For creating Groups under a namespace, set label key to
302 # 'labels/system/groups/external' and label value as empty.
303 "a_key": "A String",
304 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]305 "groupKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]306 #
307 # Must be set when creating a Group, read-only afterwards.
308 # isolation for IDs. A single ID can be reused across namespaces but the
309 # combination of a namespace and an ID must be unique.
310 "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique
311 # within its namespace.
312 #
313 # Namespaces are currently only created as part of IdentitySource creation
314 # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
315 # created corresponding to every Identity Source `identity_source_id`.
316 "id": "A String", # The ID of the entity within the given namespace. The ID must be unique
317 # within its namespace.
318 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]319 "createTime": "A String", # Output only. The time when the Group was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320 # Output only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]321 "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
322 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
323 # assigned to the Group.
324 #
325 # Must be left blank while creating a Group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]326 }</pre>
327</div>
328
329<div class="method">
330 <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None, view=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]331 <pre>Lists groups within a customer or a domain.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]332
333Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]334 parent: string, Required. Customer ID to list all groups from.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]335 pageToken: string, The next_page_token value returned from a previous list request, if any.
336 x__xgafv: string, V1 error format.
337 Allowed values
338 1 - v1 error format
339 2 - v2 error format
340 pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50
341(max 500) for the FULL view.
342 view: string, Group resource view to be returned. Defaults to [View.BASIC]().
343
344Returns:
345 An object of the form:
346
347 { # Response message for ListGroups operation.
348 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
349 # more results available for listing.
350 "groups": [ # Groups returned in response to list request.
351 # The results are not sorted.
352 { # Resource representing a Group.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]353 "updateTime": "A String", # Output only. The time when the Group was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]354 # Output only.
355 "displayName": "A String", # The Group's display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]356 "description": "A String", # An extended description to help users determine the purpose of a Group. For
357 # example, you can include information about who should join the Group, the
358 # types of messages to send to the Group, links to FAQs about the Group, or
359 # related Groups. Maximum length is 4,096 characters.
360 "parent": "A String", # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]361 # hierarchy. Must be set when creating a Group, read-only afterwards.
362 #
363 # Currently allowed types: `identitysources`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]364 "labels": { # Required. `Required`. Labels for Group resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]365 # For creating Groups under a namespace, set label key to
366 # 'labels/system/groups/external' and label value as empty.
367 "a_key": "A String",
368 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]369 "groupKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]370 #
371 # Must be set when creating a Group, read-only afterwards.
372 # isolation for IDs. A single ID can be reused across namespaces but the
373 # combination of a namespace and an ID must be unique.
374 "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique
375 # within its namespace.
376 #
377 # Namespaces are currently only created as part of IdentitySource creation
378 # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
379 # created corresponding to every Identity Source `identity_source_id`.
380 "id": "A String", # The ID of the entity within the given namespace. The ID must be unique
381 # within its namespace.
382 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]383 "createTime": "A String", # Output only. The time when the Group was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]384 # Output only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]385 "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
386 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
387 # assigned to the Group.
388 #
389 # Must be left blank while creating a Group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 },
391 ],
392 }</pre>
393</div>
394
395<div class="method">
396 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
397 <pre>Retrieves the next page of results.
398
399Args:
400 previous_request: The request for the previous page. (required)
401 previous_response: The response from the request for the previous page. (required)
402
403Returns:
404 A request object that you can call 'execute()' on to request the next
405 page. Returns None if there are no more items in the collection.
406 </pre>
407</div>
408
409<div class="method">
410 <code class="details" id="lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</code>
411 <pre>Looks up [resource
412name](https://cloud.google.com/apis/design/resource_names) of a Group by
413its EntityKey.
414
415Args:
416 groupKey_id: string, The ID of the entity within the given namespace. The ID must be unique
417within its namespace.
418 groupKey_namespace: string, Namespaces provide isolation for IDs, so an ID only needs to be unique
419within its namespace.
420
421Namespaces are currently only created as part of IdentitySource creation
422from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
423created corresponding to every Identity Source `identity_source_id`.
424 x__xgafv: string, V1 error format.
425 Allowed values
426 1 - v1 error format
427 2 - v2 error format
428
429Returns:
430 An object of the form:
431
432 {
433 "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the
434 # Group in the format: `groups/{group_id}`, where `group_id` is the unique ID
435 # assigned to the Group.
436 }</pre>
437</div>
438
439<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]440 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]441 <pre>Updates a Group.
442
443Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]444 name: string, Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]445Group in the format: `groups/{group_id}`, where group_id is the unique ID
446assigned to the Group.
447
448Must be left blank while creating a Group. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]449 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]450 The object takes the form of:
451
452{ # Resource representing a Group.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]453 "updateTime": "A String", # Output only. The time when the Group was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]454 # Output only.
455 "displayName": "A String", # The Group's display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]456 "description": "A String", # An extended description to help users determine the purpose of a Group. For
457 # example, you can include information about who should join the Group, the
458 # types of messages to send to the Group, links to FAQs about the Group, or
459 # related Groups. Maximum length is 4,096 characters.
460 "parent": "A String", # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]461 # hierarchy. Must be set when creating a Group, read-only afterwards.
462 #
463 # Currently allowed types: `identitysources`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]464 "labels": { # Required. `Required`. Labels for Group resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]465 # For creating Groups under a namespace, set label key to
466 # 'labels/system/groups/external' and label value as empty.
467 "a_key": "A String",
468 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]469 "groupKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]470 #
471 # Must be set when creating a Group, read-only afterwards.
472 # isolation for IDs. A single ID can be reused across namespaces but the
473 # combination of a namespace and an ID must be unique.
474 "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique
475 # within its namespace.
476 #
477 # Namespaces are currently only created as part of IdentitySource creation
478 # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
479 # created corresponding to every Identity Source `identity_source_id`.
480 "id": "A String", # The ID of the entity within the given namespace. The ID must be unique
481 # within its namespace.
482 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]483 "createTime": "A String", # Output only. The time when the Group was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]484 # Output only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]485 "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
486 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
487 # assigned to the Group.
488 #
489 # Must be left blank while creating a Group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]490}
491
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]492 updateMask: string, Required. Editable fields: `display_name`, `description`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]493 x__xgafv: string, V1 error format.
494 Allowed values
495 1 - v1 error format
496 2 - v2 error format
497
498Returns:
499 An object of the form:
500
501 { # This resource represents a long-running operation that is the result of a
502 # network API call.
503 "metadata": { # Service-specific metadata associated with the operation. It typically
504 # contains progress information and common metadata such as create time.
505 # Some services might not provide such metadata. Any method that returns a
506 # long-running operation should document the metadata type, if any.
507 "a_key": "", # Properties of the object. Contains field @type with type URL.
508 },
509 "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.
510 # different programming environments, including REST APIs and RPC APIs. It is
511 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
512 # three pieces of data: error code, error message, and error details.
513 #
514 # You can find out more about this error model and how to work with it in the
515 # [API Design Guide](https://cloud.google.com/apis/design/errors).
516 "message": "A String", # A developer-facing error message, which should be in English. Any
517 # user-facing error message should be localized and sent in the
518 # google.rpc.Status.details field, or localized by the client.
519 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
520 "details": [ # A list of messages that carry the error details. There is a common set of
521 # message types for APIs to use.
522 {
523 "a_key": "", # Properties of the object. Contains field @type with type URL.
524 },
525 ],
526 },
527 "done": True or False, # If the value is `false`, it means the operation is still in progress.
528 # If `true`, the operation is completed, and either `error` or `response` is
529 # available.
530 "response": { # The normal response of the operation in case of success. If the original
531 # method returns no data on success, such as `Delete`, the response is
532 # `google.protobuf.Empty`. If the original method is standard
533 # `Get`/`Create`/`Update`, the response should be the resource. For other
534 # methods, the response should have the type `XxxResponse`, where `Xxx`
535 # is the original method name. For example, if the original method name
536 # is `TakeSnapshot()`, the inferred response type is
537 # `TakeSnapshotResponse`.
538 "a_key": "", # Properties of the object. Contains field @type with type URL.
539 },
540 "name": "A String", # The server-assigned name, which is only unique within the same service that
541 # originally returns it. If you use the default HTTP mapping, the
542 # `name` should be a resource name ending with `operations/{unique_id}`.
543 }</pre>
544</div>
545
546<div class="method">
547 <code class="details" id="search">search(pageSize=None, pageToken=None, query=None, x__xgafv=None, view=None)</code>
548 <pre>Searches for Groups.
549
550Args:
551 pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50
552(max 500) for the FULL view.
553 pageToken: string, The next_page_token value returned from a previous search request, if any.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]554 query: string, Required. `Required`. Query string for performing search on groups. Users can search
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]555on parent and label attributes of groups.
556EXACT match ('==') is supported on parent, and CONTAINS match ('in') is
557supported on labels.
558 x__xgafv: string, V1 error format.
559 Allowed values
560 1 - v1 error format
561 2 - v2 error format
562 view: string, Group resource view to be returned. Defaults to [View.BASIC]().
563
564Returns:
565 An object of the form:
566
567 {
568 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
569 # more results available for specified query.
570 "groups": [ # List of Groups satisfying the search query.
571 { # Resource representing a Group.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]572 "updateTime": "A String", # Output only. The time when the Group was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]573 # Output only.
574 "displayName": "A String", # The Group's display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]575 "description": "A String", # An extended description to help users determine the purpose of a Group. For
576 # example, you can include information about who should join the Group, the
577 # types of messages to send to the Group, links to FAQs about the Group, or
578 # related Groups. Maximum length is 4,096 characters.
579 "parent": "A String", # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]580 # hierarchy. Must be set when creating a Group, read-only afterwards.
581 #
582 # Currently allowed types: `identitysources`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]583 "labels": { # Required. `Required`. Labels for Group resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]584 # For creating Groups under a namespace, set label key to
585 # 'labels/system/groups/external' and label value as empty.
586 "a_key": "A String",
587 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]588 "groupKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]589 #
590 # Must be set when creating a Group, read-only afterwards.
591 # isolation for IDs. A single ID can be reused across namespaces but the
592 # combination of a namespace and an ID must be unique.
593 "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique
594 # within its namespace.
595 #
596 # Namespaces are currently only created as part of IdentitySource creation
597 # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
598 # created corresponding to every Identity Source `identity_source_id`.
599 "id": "A String", # The ID of the entity within the given namespace. The ID must be unique
600 # within its namespace.
601 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]602 "createTime": "A String", # Output only. The time when the Group was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]603 # Output only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]604 "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
605 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
606 # assigned to the Group.
607 #
608 # Must be left blank while creating a Group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]609 },
610 ],
611 }</pre>
612</div>
613
614<div class="method">
615 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
616 <pre>Retrieves the next page of results.
617
618Args:
619 previous_request: The request for the previous page. (required)
620 previous_response: The response from the request for the previous page. (required)
621
622Returns:
623 A request object that you can call 'execute()' on to request the next
624 page. Returns None if there are no more items in the collection.
625 </pre>
626</div>
627
628</body></html>