Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / cloudidentity_v1.groups.html
blob: a926594455fe4b9ea669b126b229c6d84629f4ca [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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]92 <code><a href="#list">list(view=None, pageSize=None, pageToken=None, parent=None, x__xgafv=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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]98 <code><a href="#lookup">lookup(groupKey_namespace=None, groupKey_id=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]104 <code><a href="#search">search(pageToken=None, view=None, pageSize=None, query=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]119 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
120 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
121 # hierarchy. Must be set when creating a Group, read-only afterwards.
122 #
123 # Currently allowed types: `identitysources`.
124 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created.
125 # Output only.
126 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource.
127 # For creating Groups under a namespace, set label key to
128 # &#x27;labels/system/groups/external&#x27; and label value as empty.
129 &quot;a_key&quot;: &quot;A String&quot;,
130 },
131 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
132 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
133 # assigned to the Group.
134 #
135 # Must be left blank while creating a Group.
136 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
137 #
138 # Must be set when creating a Group, read-only afterwards.
139 # isolation for IDs. A single ID can be reused across namespaces but the
140 # combination of a namespace and an ID must be unique.
141 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique
142 # within its namespace.
143 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique
144 # within its namespace.
145 #
146 # Namespaces are currently only created as part of IdentitySource creation
147 # from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
148 # created corresponding to every Identity Source `identity_source_id`.
149 },
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;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated.
155 # Output only.
156 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]168 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169 # If `true`, the operation is completed, and either `error` or `response` is
170 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]171 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 # method returns no data on success, such as `Delete`, the response is
173 # `google.protobuf.Empty`. If the original method is standard
174 # `Get`/`Create`/`Update`, the response should be the resource. For other
175 # methods, the response should have the type `XxxResponse`, where `Xxx`
176 # is the original method name. For example, if the original method name
177 # is `TakeSnapshot()`, the inferred response type is
178 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]179 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]181 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]182 # originally returns it. If you use the default HTTP mapping, the
183 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]184 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
185 # contains progress information and common metadata such as create time.
186 # Some services might not provide such metadata. Any method that returns a
187 # long-running operation should document the metadata type, if any.
188 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
189 },
190 &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.
191 # different programming environments, including REST APIs and RPC APIs. It is
192 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
193 # three pieces of data: error code, error message, and error details.
194 #
195 # You can find out more about this error model and how to work with it in the
196 # [API Design Guide](https://cloud.google.com/apis/design/errors).
197 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
198 # user-facing error message should be localized and sent in the
199 # google.rpc.Status.details field, or localized by the client.
200 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
201 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
202 # message types for APIs to use.
203 {
204 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
205 },
206 ],
207 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]229 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]230 # If `true`, the operation is completed, and either `error` or `response` is
231 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]232 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]233 # method returns no data on success, such as `Delete`, the response is
234 # `google.protobuf.Empty`. If the original method is standard
235 # `Get`/`Create`/`Update`, the response should be the resource. For other
236 # methods, the response should have the type `XxxResponse`, where `Xxx`
237 # is the original method name. For example, if the original method name
238 # is `TakeSnapshot()`, the inferred response type is
239 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]240 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]242 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]243 # originally returns it. If you use the default HTTP mapping, the
244 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]245 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
246 # contains progress information and common metadata such as create time.
247 # Some services might not provide such metadata. Any method that returns a
248 # long-running operation should document the metadata type, if any.
249 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
250 },
251 &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.
252 # different programming environments, including REST APIs and RPC APIs. It is
253 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
254 # three pieces of data: error code, error message, and error details.
255 #
256 # You can find out more about this error model and how to work with it in the
257 # [API Design Guide](https://cloud.google.com/apis/design/errors).
258 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
259 # user-facing error message should be localized and sent in the
260 # google.rpc.Status.details field, or localized by the client.
261 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
262 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
263 # message types for APIs to use.
264 {
265 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
266 },
267 ],
268 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]289 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
290 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
291 # hierarchy. Must be set when creating a Group, read-only afterwards.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]292 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]293 # Currently allowed types: `identitysources`.
294 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created.
295 # Output only.
296 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource.
297 # For creating Groups under a namespace, set label key to
298 # &#x27;labels/system/groups/external&#x27; and label value as empty.
299 &quot;a_key&quot;: &quot;A String&quot;,
300 },
301 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
302 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
303 # assigned to the Group.
304 #
305 # Must be left blank while creating a Group.
306 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
307 #
308 # Must be set when creating a Group, read-only afterwards.
309 # isolation for IDs. A single ID can be reused across namespaces but the
310 # combination of a namespace and an ID must be unique.
311 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique
312 # within its namespace.
313 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique
314 # within its namespace.
315 #
316 # Namespaces are currently only created as part of IdentitySource creation
317 # from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
318 # created corresponding to every Identity Source `identity_source_id`.
319 },
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;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated.
325 # Output only.
326 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]327</div>
328
329<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]330 <code class="details" id="list">list(view=None, pageSize=None, pageToken=None, parent=None, x__xgafv=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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]334 view: string, Group resource view to be returned. Defaults to [View.BASIC]().
335 pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50
336(max 500) for the FULL view.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]337 pageToken: string, The next_page_token value returned from a previous list request, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]338 parent: string, Required. Customer ID to list all groups from.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]339 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 -0700[diff] [blame]343
344Returns:
345 An object of the form:
346
347 { # Response message for ListGroups operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]348 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]349 # more results available for listing.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]350 &quot;groups&quot;: [ # Groups returned in response to list request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]351 # The results are not sorted.
352 { # Resource representing a Group.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]353 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
354 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
355 # hierarchy. Must be set when creating a Group, read-only afterwards.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]356 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]357 # Currently allowed types: `identitysources`.
358 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created.
359 # Output only.
360 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource.
361 # For creating Groups under a namespace, set label key to
362 # &#x27;labels/system/groups/external&#x27; and label value as empty.
363 &quot;a_key&quot;: &quot;A String&quot;,
364 },
365 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
366 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
367 # assigned to the Group.
368 #
369 # Must be left blank while creating a Group.
370 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
371 #
372 # Must be set when creating a Group, read-only afterwards.
373 # isolation for IDs. A single ID can be reused across namespaces but the
374 # combination of a namespace and an ID must be unique.
375 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique
376 # within its namespace.
377 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique
378 # within its namespace.
379 #
380 # Namespaces are currently only created as part of IdentitySource creation
381 # from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
382 # created corresponding to every Identity Source `identity_source_id`.
383 },
384 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a Group. For
385 # example, you can include information about who should join the Group, the
386 # types of messages to send to the Group, links to FAQs about the Group, or
387 # related Groups. Maximum length is 4,096 characters.
388 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated.
389 # Output only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]404 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]405 page. Returns None if there are no more items in the collection.
406 </pre>
407</div>
408
409<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]410 <code class="details" id="lookup">lookup(groupKey_namespace=None, groupKey_id=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]411 <pre>Looks up [resource
412name](https://cloud.google.com/apis/design/resource_names) of a Group by
413its EntityKey.
414
415Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]416 groupKey_namespace: string, Namespaces provide isolation for IDs, so an ID only needs to be unique
417within its namespace.
418
419Namespaces are currently only created as part of IdentitySource creation
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]420from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]421created corresponding to every Identity Source `identity_source_id`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]422 groupKey_id: string, The ID of the entity within the given namespace. The ID must be unique
423within its namespace.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 -0700[diff] [blame^]433 &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 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]453 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
454 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
455 # hierarchy. Must be set when creating a Group, read-only afterwards.
456 #
457 # Currently allowed types: `identitysources`.
458 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created.
459 # Output only.
460 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource.
461 # For creating Groups under a namespace, set label key to
462 # &#x27;labels/system/groups/external&#x27; and label value as empty.
463 &quot;a_key&quot;: &quot;A String&quot;,
464 },
465 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
466 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
467 # assigned to the Group.
468 #
469 # Must be left blank while creating a Group.
470 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
471 #
472 # Must be set when creating a Group, read-only afterwards.
473 # isolation for IDs. A single ID can be reused across namespaces but the
474 # combination of a namespace and an ID must be unique.
475 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique
476 # within its namespace.
477 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique
478 # within its namespace.
479 #
480 # Namespaces are currently only created as part of IdentitySource creation
481 # from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
482 # created corresponding to every Identity Source `identity_source_id`.
483 },
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;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated.
489 # Output only.
490 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]503 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]504 # If `true`, the operation is completed, and either `error` or `response` is
505 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]506 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]507 # method returns no data on success, such as `Delete`, the response is
508 # `google.protobuf.Empty`. If the original method is standard
509 # `Get`/`Create`/`Update`, the response should be the resource. For other
510 # methods, the response should have the type `XxxResponse`, where `Xxx`
511 # is the original method name. For example, if the original method name
512 # is `TakeSnapshot()`, the inferred response type is
513 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]514 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]515 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]516 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]517 # originally returns it. If you use the default HTTP mapping, the
518 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]519 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
520 # contains progress information and common metadata such as create time.
521 # Some services might not provide such metadata. Any method that returns a
522 # long-running operation should document the metadata type, if any.
523 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
524 },
525 &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.
526 # different programming environments, including REST APIs and RPC APIs. It is
527 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
528 # three pieces of data: error code, error message, and error details.
529 #
530 # You can find out more about this error model and how to work with it in the
531 # [API Design Guide](https://cloud.google.com/apis/design/errors).
532 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
533 # user-facing error message should be localized and sent in the
534 # google.rpc.Status.details field, or localized by the client.
535 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
536 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
537 # message types for APIs to use.
538 {
539 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
540 },
541 ],
542 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]543 }</pre>
544</div>
545
546<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]547 <code class="details" id="search">search(pageToken=None, view=None, pageSize=None, query=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]548 <pre>Searches for Groups.
549
550Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]551 pageToken: string, The next_page_token value returned from a previous search request, if any.
552 view: string, Group resource view to be returned. Defaults to [View.BASIC]().
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]553 pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50
554(max 500) for the FULL view.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]555 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]556on parent and label attributes of groups.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]557EXACT match (&#x27;==&#x27;) is supported on parent, and CONTAINS match (&#x27;in&#x27;) is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]558supported on labels.
559 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 -0700[diff] [blame]563
564Returns:
565 An object of the form:
566
567 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]568 &quot;groups&quot;: [ # List of Groups satisfying the search query.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]569 { # Resource representing a Group.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]570 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
571 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource
572 # hierarchy. Must be set when creating a Group, read-only afterwards.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]573 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]574 # Currently allowed types: `identitysources`.
575 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created.
576 # Output only.
577 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource.
578 # For creating Groups under a namespace, set label key to
579 # &#x27;labels/system/groups/external&#x27; and label value as empty.
580 &quot;a_key&quot;: &quot;A String&quot;,
581 },
582 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
583 # Group in the format: `groups/{group_id}`, where group_id is the unique ID
584 # assigned to the Group.
585 #
586 # Must be left blank while creating a Group.
587 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the Group.
588 #
589 # Must be set when creating a Group, read-only afterwards.
590 # isolation for IDs. A single ID can be reused across namespaces but the
591 # combination of a namespace and an ID must be unique.
592 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique
593 # within its namespace.
594 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique
595 # within its namespace.
596 #
597 # Namespaces are currently only created as part of IdentitySource creation
598 # from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is
599 # created corresponding to every Identity Source `identity_source_id`.
600 },
601 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a Group. For
602 # example, you can include information about who should join the Group, the
603 # types of messages to send to the Group, links to FAQs about the Group, or
604 # related Groups. Maximum length is 4,096 characters.
605 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated.
606 # Output only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]607 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]608 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]609 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
610 # more results available for specified query.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 -0700[diff] [blame^]623 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]624 page. Returns None if there are no more items in the collection.
625 </pre>
626</div>
627
628</body></html>