Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / cloudidentity_v1.groups.html
blob: 90443788c98b2c07fb6ed54323a7ec878f43b599 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
86 <code><a href="#create">create(body=None, initialGroupConfig=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87<p class="firstline">Creates a Group.</p>
88<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Deletes a Group.</p>
91<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93<p class="firstline">Retrieves a Group.</p>
94<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]95 <code><a href="#list">list(pageToken=None, view=None, pageSize=None, parent=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96<p class="firstline">Lists groups within a customer or a domain.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]101 <code><a href="#lookup">lookup(groupKey_namespace=None, groupKey_id=None, x__xgafv=None)</a></code></p>
102<p class="firstline">Looks up [resource name](https://cloud.google.com/apis/design/resource_names) of a Group by its EntityKey.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104 <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]105<p class="firstline">Updates a Group.</p>
106<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]107 <code><a href="#search">search(pageToken=None, query=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108<p class="firstline">Searches for Groups.</p>
109<p class="toc_element">
110 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
111<p class="firstline">Retrieves the next page of results.</p>
112<h3>Method Details</h3>
113<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]114 <code class="details" id="close">close()</code>
115 <pre>Close httplib2 connections.</pre>
116</div>
117
118<div class="method">
119 <code class="details" id="create">create(body=None, initialGroupConfig=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120 <pre>Creates a Group.
121
122Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]123 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 The object takes the form of:
125
126{ # Resource representing a Group.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]127 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource. For creating Groups under a namespace, set label key to &#x27;labels/system/groups/external&#x27; and label value as empty.
128 &quot;a_key&quot;: &quot;A String&quot;,
129 },
130 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a Group. For example, you can include information about who should join the Group, the types of messages to send to the Group, links to FAQs about the Group, or related Groups. Maximum length is 4,096 characters.
131 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created. Output only.
132 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique. # Required. Immutable. EntityKey of the Group. Must be set when creating a Group, read-only afterwards.
133 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is created corresponding to every Identity Source `identity_source_id`.
134 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique within its namespace.
135 },
136 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
137 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated. Output only.
138 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group.
139 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: `identitysources`.
140 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]142 initialGroupConfig: string, Optional. The initial configuration option for the `Group`.
143 Allowed values
144 INITIAL_GROUP_CONFIG_UNSPECIFIED - Default. Should not be used.
145 WITH_INITIAL_OWNER - The end user making the request will be added as the initial owner of the `Group`.
146 EMPTY - An empty group is created without any initial owners. This can only be used by admins of the domain.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 x__xgafv: string, V1 error format.
148 Allowed values
149 1 - v1 error format
150 2 - v2 error format
151
152Returns:
153 An object of the form:
154
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]155 { # This resource represents a long-running operation that is the result of a network API call.
156 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
157 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
158 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
159 },
160 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
161 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
162 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]163 {
164 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
165 },
166 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]167 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]168 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]169 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
170 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]171 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
172 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]173 }</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
178 <pre>Deletes a Group.
179
180Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]181 name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]182 x__xgafv: string, V1 error format.
183 Allowed values
184 1 - v1 error format
185 2 - v2 error format
186
187Returns:
188 An object of the form:
189
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]190 { # This resource represents a long-running operation that is the result of a network API call.
191 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
192 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
193 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
194 },
195 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
196 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
197 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]198 {
199 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
200 },
201 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]202 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]203 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]204 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
205 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]206 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
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="get">get(name, x__xgafv=None)</code>
213 <pre>Retrieves a Group.
214
215Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]216 name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]217 x__xgafv: string, V1 error format.
218 Allowed values
219 1 - v1 error format
220 2 - v2 error format
221
222Returns:
223 An object of the form:
224
225 { # Resource representing a Group.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]226 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource. For creating Groups under a namespace, set label key to &#x27;labels/system/groups/external&#x27; and label value as empty.
227 &quot;a_key&quot;: &quot;A String&quot;,
228 },
229 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a Group. For example, you can include information about who should join the Group, the types of messages to send to the Group, links to FAQs about the Group, or related Groups. Maximum length is 4,096 characters.
230 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created. Output only.
231 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique. # Required. Immutable. EntityKey of the Group. Must be set when creating a Group, read-only afterwards.
232 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is created corresponding to every Identity Source `identity_source_id`.
233 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique within its namespace.
234 },
235 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
236 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated. Output only.
237 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group.
238 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: `identitysources`.
239 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240</div>
241
242<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]243 <code class="details" id="list">list(pageToken=None, view=None, pageSize=None, parent=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]244 <pre>Lists groups within a customer or a domain.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]245
246Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]247 pageToken: string, The next_page_token value returned from a previous list request, if any.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]248 view: string, Group resource view to be returned. Defaults to [View.BASIC]().
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]249 Allowed values
250 VIEW_UNSPECIFIED - Default. Should not be used.
251 BASIC - Server responses only include basic information.
252 FULL - Full representation of the resource.
253 pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]254 parent: string, Required. Customer ID to list all groups from.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 x__xgafv: string, V1 error format.
256 Allowed values
257 1 - v1 error format
258 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]259
260Returns:
261 An object of the form:
262
263 { # Response message for ListGroups operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]264 &quot;groups&quot;: [ # Groups returned in response to list request. The results are not sorted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265 { # Resource representing a Group.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]266 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource. For creating Groups under a namespace, set label key to &#x27;labels/system/groups/external&#x27; and label value as empty.
267 &quot;a_key&quot;: &quot;A String&quot;,
268 },
269 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a Group. For example, you can include information about who should join the Group, the types of messages to send to the Group, links to FAQs about the Group, or related Groups. Maximum length is 4,096 characters.
270 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created. Output only.
271 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique. # Required. Immutable. EntityKey of the Group. Must be set when creating a Group, read-only afterwards.
272 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is created corresponding to every Identity Source `identity_source_id`.
273 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique within its namespace.
274 },
275 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
276 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated. Output only.
277 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group.
278 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: `identitysources`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]280 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]281 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results available for listing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 }</pre>
283</div>
284
285<div class="method">
286 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
287 <pre>Retrieves the next page of results.
288
289Args:
290 previous_request: The request for the previous page. (required)
291 previous_response: The response from the request for the previous page. (required)
292
293Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]294 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]295 page. Returns None if there are no more items in the collection.
296 </pre>
297</div>
298
299<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]300 <code class="details" id="lookup">lookup(groupKey_namespace=None, groupKey_id=None, x__xgafv=None)</code>
301 <pre>Looks up [resource name](https://cloud.google.com/apis/design/resource_names) of a Group by its EntityKey.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]302
303Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]304 groupKey_namespace: string, Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is created corresponding to every Identity Source `identity_source_id`.
305 groupKey_id: string, The ID of the entity within the given namespace. The ID must be unique within its namespace.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]306 x__xgafv: string, V1 error format.
307 Allowed values
308 1 - v1 error format
309 2 - v2 error format
310
311Returns:
312 An object of the form:
313
314 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]315 &quot;name&quot;: &quot;A String&quot;, # [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]316 }</pre>
317</div>
318
319<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]320 <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]321 <pre>Updates a Group.
322
323Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]324 name: string, Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]325 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]326 The object takes the form of:
327
328{ # Resource representing a Group.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]329 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource. For creating Groups under a namespace, set label key to &#x27;labels/system/groups/external&#x27; and label value as empty.
330 &quot;a_key&quot;: &quot;A String&quot;,
331 },
332 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a Group. For example, you can include information about who should join the Group, the types of messages to send to the Group, links to FAQs about the Group, or related Groups. Maximum length is 4,096 characters.
333 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created. Output only.
334 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique. # Required. Immutable. EntityKey of the Group. Must be set when creating a Group, read-only afterwards.
335 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is created corresponding to every Identity Source `identity_source_id`.
336 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique within its namespace.
337 },
338 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
339 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated. Output only.
340 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group.
341 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: `identitysources`.
342 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]343
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]344 updateMask: string, Required. Editable fields: `display_name`, `description`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]345 x__xgafv: string, V1 error format.
346 Allowed values
347 1 - v1 error format
348 2 - v2 error format
349
350Returns:
351 An object of the form:
352
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]353 { # This resource represents a long-running operation that is the result of a network API call.
354 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
355 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
356 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
357 },
358 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
359 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
360 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]361 {
362 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
363 },
364 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]365 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]366 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]367 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
368 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]369 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
370 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]371 }</pre>
372</div>
373
374<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]375 <code class="details" id="search">search(pageToken=None, query=None, pageSize=None, view=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]376 <pre>Searches for Groups.
377
378Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]379 pageToken: string, The next_page_token value returned from a previous search request, if any.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]380 query: string, Required. `Required`. Query string for performing search on groups. Users can search on parent and label attributes of groups. EXACT match (&#x27;==&#x27;) is supported on parent, and CONTAINS match (&#x27;in&#x27;) is supported on labels.
381 pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view.
382 view: string, Group resource view to be returned. Defaults to [View.BASIC]().
383 Allowed values
384 VIEW_UNSPECIFIED - Default. Should not be used.
385 BASIC - Server responses only include basic information.
386 FULL - Full representation of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]387 x__xgafv: string, V1 error format.
388 Allowed values
389 1 - v1 error format
390 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]391
392Returns:
393 An object of the form:
394
395 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]396 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results available for specified query.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]397 &quot;groups&quot;: [ # List of Groups satisfying the search query.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]398 { # Resource representing a Group.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]399 &quot;labels&quot;: { # Required. `Required`. Labels for Group resource. For creating Groups under a namespace, set label key to &#x27;labels/system/groups/external&#x27; and label value as empty.
400 &quot;a_key&quot;: &quot;A String&quot;,
401 },
402 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a Group. For example, you can include information about who should join the Group, the types of messages to send to the Group, links to FAQs about the Group, or related Groups. Maximum length is 4,096 characters.
403 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was created. Output only.
404 &quot;groupKey&quot;: { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique. # Required. Immutable. EntityKey of the Group. Must be set when creating a Group, read-only afterwards.
405 &quot;namespace&quot;: &quot;A String&quot;, # Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `&quot;identitysources/{identity_source_id}&quot;` is created corresponding to every Identity Source `identity_source_id`.
406 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity within the given namespace. The ID must be unique within its namespace.
407 },
408 &quot;displayName&quot;: &quot;A String&quot;, # The Group&#x27;s display name.
409 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Group was last updated. Output only.
410 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group.
411 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: `identitysources`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]412 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]413 ],
414 }</pre>
415</div>
416
417<div class="method">
418 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
419 <pre>Retrieves the next page of results.
420
421Args:
422 previous_request: The request for the previous page. (required)
423 previous_response: The response from the request for the previous page. (required)
424
425Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]426 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]427 page. Returns None if there are no more items in the collection.
428 </pre>
429</div>
430
431</body></html>