blob: 602f5110319d7068d8170aa4251418c5afeb3a0e [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudidentity_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 -070083 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070084<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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070092 <code><a href="#list">list(pageToken=None, view=None, parent=None, pageSize=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070093<p class="firstline">Lists groups within a customer or a domain.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070098 <code><a href="#lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070099<p class="firstline">Looks up [resource</p>
100<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700102<p class="firstline">Updates a Group.</p>
103<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700104 <code><a href="#search">search(query=None, view=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700105<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 -0700111 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700112 <pre>Creates a Group.
113
114Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700115 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700116 The object takes the form of:
117
118{ # Resource representing a Group.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700119 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
120 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource.
121 # For creating Groups under a namespace, set label key to
122 # &#x27;labels/system/groups/external&#x27; and label value as empty.
123 &quot;a_key&quot;: &quot;A String&quot;,
124 },
125 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated.
126 # Output only.
127 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
128 #
129 # Must be set when creating a Group, read-only afterwards.
130 # isolation for IDs. A single ID can be reused across namespaces but the
131 # combination of a namespace and an ID must be unique.
132 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique
133 # within its namespace.
134 #
135 # Namespaces are currently only created as part of IdentitySource creation
136 # from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
137 # created corresponding to every Identity Source `identity_source_id`.
138 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique
139 # within its namespace.
140 },
141 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
142 # hierarchy. Must be set when creating a Group, read-only afterwards.
143 #
144 # Currently allowed types: `identitysources`.
145 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
146 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
147 # assigned to the Group.
148 #
149 # Must be left blank while creating a Group.
150 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a Group. For
151 # example, you can include information about who should join the Group, the
152 # types of messages to send to the Group, links to FAQs about the Group, or
153 # related Groups. Maximum length is 4,096 characters.
154 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created.
155 # Output only.
156}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700157
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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700168 &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.
169 # different programming environments, including REST APIs and RPC APIs. It is
170 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
171 # three pieces of data: error code, error message, and error details.
172 #
173 # You can find out more about this error model and how to work with it in the
174 # [API Design Guide](https://cloud.google.com/apis/design/errors).
175 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
176 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
177 # message types for APIs to use.
178 {
179 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
180 },
181 ],
182 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
183 # user-facing error message should be localized and sent in the
184 # google.rpc.Status.details field, or localized by the client.
185 },
186 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
187 # contains progress information and common metadata such as create time.
188 # Some services might not provide such metadata. Any method that returns a
189 # long-running operation should document the metadata type, if any.
190 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
191 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700192 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700193 # method returns no data on success, such as `Delete`, the response is
194 # `google.protobuf.Empty`. If the original method is standard
195 # `Get`/`Create`/`Update`, the response should be the resource. For other
196 # methods, the response should have the type `XxxResponse`, where `Xxx`
197 # is the original method name. For example, if the original method name
198 # is `TakeSnapshot()`, the inferred response type is
199 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700200 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700201 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700202 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
203 # originally returns it. If you use the default HTTP mapping, the
204 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700205 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
206 # If `true`, the operation is completed, and either `error` or `response` is
207 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700208 }</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 -0700216 name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700217Group 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700229 &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.
230 # different programming environments, including REST APIs and RPC APIs. It is
231 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
232 # three pieces of data: error code, error message, and error details.
233 #
234 # You can find out more about this error model and how to work with it in the
235 # [API Design Guide](https://cloud.google.com/apis/design/errors).
236 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
237 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
238 # message types for APIs to use.
239 {
240 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
241 },
242 ],
243 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
244 # user-facing error message should be localized and sent in the
245 # google.rpc.Status.details field, or localized by the client.
246 },
247 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
248 # contains progress information and common metadata such as create time.
249 # Some services might not provide such metadata. Any method that returns a
250 # long-running operation should document the metadata type, if any.
251 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
252 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700253 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700254 # method returns no data on success, such as `Delete`, the response is
255 # `google.protobuf.Empty`. If the original method is standard
256 # `Get`/`Create`/`Update`, the response should be the resource. For other
257 # methods, the response should have the type `XxxResponse`, where `Xxx`
258 # is the original method name. For example, if the original method name
259 # is `TakeSnapshot()`, the inferred response type is
260 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700261 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700262 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700263 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
264 # originally returns it. If you use the default HTTP mapping, the
265 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700266 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
267 # If `true`, the operation is completed, and either `error` or `response` is
268 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700269 }</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 -0700277 name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700278Group 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700289 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
290 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource.
291 # For creating Groups under a namespace, set label key to
292 # &#x27;labels/system/groups/external&#x27; and label value as empty.
293 &quot;a_key&quot;: &quot;A String&quot;,
294 },
295 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated.
296 # Output only.
297 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
298 #
299 # Must be set when creating a Group, read-only afterwards.
300 # isolation for IDs. A single ID can be reused across namespaces but the
301 # combination of a namespace and an ID must be unique.
302 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique
303 # within its namespace.
Bu Sun Kim65020912020-05-20 12:08:20 -0700304 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700305 # Namespaces are currently only created as part of IdentitySource creation
306 # from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
307 # created corresponding to every Identity Source `identity_source_id`.
308 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique
309 # within its namespace.
310 },
311 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
312 # hierarchy. Must be set when creating a Group, read-only afterwards.
313 #
314 # Currently allowed types: `identitysources`.
315 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
316 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
317 # assigned to the Group.
318 #
319 # Must be left blank while creating a Group.
320 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a Group. For
321 # example, you can include information about who should join the Group, the
322 # types of messages to send to the Group, links to FAQs about the Group, or
323 # related Groups. Maximum length is 4,096 characters.
324 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created.
325 # Output only.
326 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700327</div>
328
329<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700330 <code class="details" id="list">list(pageToken=None, view=None, parent=None, pageSize=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700331 <pre>Lists groups within a customer or a domain.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700332
333Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700334 pageToken: string, The next_page_token value returned from a previous list request, if any.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700335 view: string, Group resource view to be returned. Defaults to [View.BASIC]().
Bu Sun Kim65020912020-05-20 12:08:20 -0700336 parent: string, Required. Customer ID to list all groups from.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700337 pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50
338(max 500) for the FULL view.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700339 x__xgafv: string, V1 error format.
340 Allowed values
341 1 - v1 error format
342 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700343
344Returns:
345 An object of the form:
346
347 { # Response message for ListGroups operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700348 &quot;groups&quot;: [ # Groups returned in response to list request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700349 # The results are not sorted.
350 { # Resource representing a Group.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700351 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
352 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource.
353 # For creating Groups under a namespace, set label key to
354 # &#x27;labels/system/groups/external&#x27; and label value as empty.
355 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700356 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700357 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated.
358 # Output only.
359 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
360 #
361 # Must be set when creating a Group, read-only afterwards.
362 # isolation for IDs. A single ID can be reused across namespaces but the
363 # combination of a namespace and an ID must be unique.
364 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique
365 # within its namespace.
366 #
367 # Namespaces are currently only created as part of IdentitySource creation
368 # from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
369 # created corresponding to every Identity Source `identity_source_id`.
370 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique
371 # within its namespace.
372 },
373 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
374 # hierarchy. Must be set when creating a Group, read-only afterwards.
375 #
376 # Currently allowed types: `identitysources`.
377 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
378 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
379 # assigned to the Group.
380 #
381 # Must be left blank while creating a Group.
382 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a Group. For
383 # example, you can include information about who should join the Group, the
384 # types of messages to send to the Group, links to FAQs about the Group, or
385 # related Groups. Maximum length is 4,096 characters.
386 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created.
387 # Output only.
388 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700389 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700390 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
391 # more results available for listing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700392 }</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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700404 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700405 page. Returns None if there are no more items in the collection.
406 </pre>
407</div>
408
409<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700410 <code class="details" id="lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700411 <pre>Looks up [resource
412name](https://cloud.google.com/apis/design/resource_names) of a Group by
413its EntityKey.
414
415Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700416 groupKey_id: string, The ID of the entity within the given namespace. The ID must be unique
417within its namespace.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700418 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
Bu Sun Kim65020912020-05-20 12:08:20 -0700422from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700423created 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 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700433 &quot;name&quot;: &quot;A String&quot;, # [Resource name](https://cloud.google.com/apis/design/resource_names) of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700434 # 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 -0700440 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700441 <pre>Updates a Group.
442
443Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700444 name: string, Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700445Group 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 -0700449 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700450 The object takes the form of:
451
452{ # Resource representing a Group.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700453 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
454 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource.
455 # For creating Groups under a namespace, set label key to
456 # &#x27;labels/system/groups/external&#x27; and label value as empty.
457 &quot;a_key&quot;: &quot;A String&quot;,
458 },
459 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated.
460 # Output only.
461 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
462 #
463 # Must be set when creating a Group, read-only afterwards.
464 # isolation for IDs. A single ID can be reused across namespaces but the
465 # combination of a namespace and an ID must be unique.
466 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique
467 # within its namespace.
468 #
469 # Namespaces are currently only created as part of IdentitySource creation
470 # from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
471 # created corresponding to every Identity Source `identity_source_id`.
472 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique
473 # within its namespace.
474 },
475 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
476 # hierarchy. Must be set when creating a Group, read-only afterwards.
477 #
478 # Currently allowed types: `identitysources`.
479 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
480 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
481 # assigned to the Group.
482 #
483 # Must be left blank while creating a Group.
484 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a Group. For
485 # example, you can include information about who should join the Group, the
486 # types of messages to send to the Group, links to FAQs about the Group, or
487 # related Groups. Maximum length is 4,096 characters.
488 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created.
489 # Output only.
490}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700491
Dan O'Mearadd494642020-05-01 07:42:23 -0700492 updateMask: string, Required. Editable fields: `display_name`, `description`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700493 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700503 &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.
504 # different programming environments, including REST APIs and RPC APIs. It is
505 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
506 # three pieces of data: error code, error message, and error details.
507 #
508 # You can find out more about this error model and how to work with it in the
509 # [API Design Guide](https://cloud.google.com/apis/design/errors).
510 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
511 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
512 # message types for APIs to use.
513 {
514 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
515 },
516 ],
517 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
518 # user-facing error message should be localized and sent in the
519 # google.rpc.Status.details field, or localized by the client.
520 },
521 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
522 # contains progress information and common metadata such as create time.
523 # Some services might not provide such metadata. Any method that returns a
524 # long-running operation should document the metadata type, if any.
525 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
526 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700527 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700528 # method returns no data on success, such as `Delete`, the response is
529 # `google.protobuf.Empty`. If the original method is standard
530 # `Get`/`Create`/`Update`, the response should be the resource. For other
531 # methods, the response should have the type `XxxResponse`, where `Xxx`
532 # is the original method name. For example, if the original method name
533 # is `TakeSnapshot()`, the inferred response type is
534 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700535 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700536 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700537 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
538 # originally returns it. If you use the default HTTP mapping, the
539 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700540 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
541 # If `true`, the operation is completed, and either `error` or `response` is
542 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700543 }</pre>
544</div>
545
546<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700547 <code class="details" id="search">search(query=None, view=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700548 <pre>Searches for Groups.
549
550Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700551 query: string, Required. `Required`. Query string for performing search on groups. Users can search
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700552on parent and label attributes of groups.
Bu Sun Kim65020912020-05-20 12:08:20 -0700553EXACT match (&#x27;==&#x27;) is supported on parent, and CONTAINS match (&#x27;in&#x27;) is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700554supported on labels.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700555 view: string, Group resource view to be returned. Defaults to [View.BASIC]().
556 pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50
557(max 500) for the FULL view.
558 pageToken: string, The next_page_token value returned from a previous search request, if any.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700559 x__xgafv: string, V1 error format.
560 Allowed values
561 1 - v1 error format
562 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700563
564Returns:
565 An object of the form:
566
567 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700568 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
569 # more results available for specified query.
Bu Sun Kim65020912020-05-20 12:08:20 -0700570 &quot;groups&quot;: [ # List of Groups satisfying the search query.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700571 { # Resource representing a Group.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700572 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
573 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource.
574 # For creating Groups under a namespace, set label key to
575 # &#x27;labels/system/groups/external&#x27; and label value as empty.
576 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700577 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700578 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated.
579 # Output only.
580 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
581 #
582 # Must be set when creating a Group, read-only afterwards.
583 # isolation for IDs. A single ID can be reused across namespaces but the
584 # combination of a namespace and an ID must be unique.
585 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique
586 # within its namespace.
587 #
588 # Namespaces are currently only created as part of IdentitySource creation
589 # from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
590 # created corresponding to every Identity Source `identity_source_id`.
591 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique
592 # within its namespace.
593 },
594 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
595 # hierarchy. Must be set when creating a Group, read-only afterwards.
596 #
597 # Currently allowed types: `identitysources`.
598 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
599 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
600 # assigned to the Group.
601 #
602 # Must be left blank while creating a Group.
603 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a Group. For
604 # example, you can include information about who should join the Group, the
605 # types of messages to send to the Group, links to FAQs about the Group, or
606 # related Groups. Maximum length is 4,096 characters.
607 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created.
608 # Output only.
609 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700610 ],
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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700623 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700624 page. Returns None if there are no more items in the collection.
625 </pre>
626</div>
627
628</body></html>