Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / cloudidentity_v1beta1.groups.html
blob: c0f90a9bf96f1b7f4e376882baa4a0a86204023d [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudidentity_v1beta1.html">Cloud Identity API</a> . <a href="cloudidentity_v1beta1.groups.html">groups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="cloudidentity_v1beta1.groups.memberships.html">memberships()</a></code>
79</p>
80<p class="firstline">Returns the memberships Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]83 <code><a href="#create">create(body=None, initialGroupConfig=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Creates a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="toc_element">
86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87<p class="firstline">Deletes a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90<p class="firstline">Retrieves a `Group`.</p>
91<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92 <code><a href="#list">list(pageSize=None, view=None, parent=None, pageToken=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93<p class="firstline">Lists the `Group`s under a customer or namespace.</p>
94<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="toc_element">
98 <code><a href="#lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99<p class="firstline">Looks up the [resource</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
102<p class="firstline">Updates a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 <code><a href="#search">search(view=None, pageToken=None, query=None, pageSize=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]105<p class="firstline">Searches for `Group`s matching a specified query.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106<p class="toc_element">
107 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
108<p class="firstline">Retrieves the next page of results.</p>
109<h3>Method Details</h3>
110<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]111 <code class="details" id="create">create(body=None, initialGroupConfig=None, x__xgafv=None)</code>
112 <pre>Creates a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113
114Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 The object takes the form of:
117
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]118{ # A group within the Cloud Identity Groups API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 #
120 # A `Group` is a collection of entities, where each entity is either a user,
121 # another group or a service account.
122 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
123 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]124 #
125 # An entity can represent either a group with an optional `namespace` or a user
126 # without a `namespace`. The combination of `id` and `namespace` must be
127 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]130 # If not specified, the `EntityKey` represents a Google-managed entity such
131 # as a Google user or a Google Group.
132 #
133 # If specified, the `EntityKey` represents an external-identity-mapped group.
134 # The namespace must correspond to an identity source created in Admin
135 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]136 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]137 #
138 # For Google-managed entities, the `id` must be the email address of an
139 # existing group or user.
140 #
141 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]142 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]143 #
144 # Must be unique within a `namespace`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]146 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
147 #
148 # Must not be longer than 4,096 characters.
149 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
150 { # A unique identifier for an entity in the Cloud Identity Groups API.
151 #
152 # An entity can represent either a group with an optional `namespace` or a user
153 # without a `namespace`. The combination of `id` and `namespace` must be
154 # unique; however, the same `id` can be used with different `namespace`s.
155 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
156 #
157 # If not specified, the `EntityKey` represents a Google-managed entity such
158 # as a Google user or a Google Group.
159 #
160 # If specified, the `EntityKey` represents an external-identity-mapped group.
161 # The namespace must correspond to an identity source created in Admin
162 # Console and must be in the form of `identitysources/{identity_source_id}.
163 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
164 #
165 # For Google-managed entities, the `id` must be the email address of an
166 # existing group or user.
167 #
168 # For external-identity-mapped entities, the `id` must be a string conforming
169 # to the Identity Source&#x27;s requirements.
170 #
171 # Must be unique within a `namespace`.
172 },
173 ],
174 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
175 # Cloud Identity resource hierarchy.
176 #
177 # Must be of the form `identitysources/{identity_source_id}` for external-
178 # identity-mapped groups or `customers/{customer_id}` for Google Groups.
179 &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
180 #
181 # Must not contain more than one entry. Must contain the entry
182 # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
183 # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
184 # external-identity-mapped group.
185 &quot;a_key&quot;: &quot;A String&quot;,
186 },
187 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
188 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
189 # the `Group`.
190 #
191 # Shall be of the form `groups/{group_id}`.
192 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
193 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]195 initialGroupConfig: string, Required. The initial configuration option for the `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 x__xgafv: string, V1 error format.
197 Allowed values
198 1 - v1 error format
199 2 - v2 error format
200
201Returns:
202 An object of the form:
203
204 { # This resource represents a long-running operation that is the result of a
205 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
207 # If `true`, the operation is completed, and either `error` or `response` is
208 # available.
209 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
210 # originally returns it. If you use the default HTTP mapping, the
211 # `name` should be a resource name ending with `operations/{unique_id}`.
212 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
213 # contains progress information and common metadata such as create time.
214 # Some services might not provide such metadata. Any method that returns a
215 # long-running operation should document the metadata type, if any.
216 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
217 },
218 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]219 # method returns no data on success, such as `Delete`, the response is
220 # `google.protobuf.Empty`. If the original method is standard
221 # `Get`/`Create`/`Update`, the response should be the resource. For other
222 # methods, the response should have the type `XxxResponse`, where `Xxx`
223 # is the original method name. For example, if the original method name
224 # is `TakeSnapshot()`, the inferred response type is
225 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]226 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]227 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]228 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 # different programming environments, including REST APIs and RPC APIs. It is
230 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
231 # three pieces of data: error code, error message, and error details.
232 #
233 # You can find out more about this error model and how to work with it in the
234 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]235 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]236 # message types for APIs to use.
237 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]238 &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]239 },
240 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]241 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
242 # user-facing error message should be localized and sent in the
243 # google.rpc.Status.details field, or localized by the client.
244 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]245 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246 }</pre>
247</div>
248
249<div class="method">
250 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]251 <pre>Deletes a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252
253Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]254 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of
255the `Group` to retrieve.
256
257Must be of the form `groups/{group_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]258 x__xgafv: string, V1 error format.
259 Allowed values
260 1 - v1 error format
261 2 - v2 error format
262
263Returns:
264 An object of the form:
265
266 { # This resource represents a long-running operation that is the result of a
267 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]268 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
269 # If `true`, the operation is completed, and either `error` or `response` is
270 # available.
271 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
272 # originally returns it. If you use the default HTTP mapping, the
273 # `name` should be a resource name ending with `operations/{unique_id}`.
274 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
275 # contains progress information and common metadata such as create time.
276 # Some services might not provide such metadata. Any method that returns a
277 # long-running operation should document the metadata type, if any.
278 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
279 },
280 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]281 # method returns no data on success, such as `Delete`, the response is
282 # `google.protobuf.Empty`. If the original method is standard
283 # `Get`/`Create`/`Update`, the response should be the resource. For other
284 # methods, the response should have the type `XxxResponse`, where `Xxx`
285 # is the original method name. For example, if the original method name
286 # is `TakeSnapshot()`, the inferred response type is
287 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]288 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]289 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]290 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]291 # different programming environments, including REST APIs and RPC APIs. It is
292 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
293 # three pieces of data: error code, error message, and error details.
294 #
295 # You can find out more about this error model and how to work with it in the
296 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]297 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]298 # message types for APIs to use.
299 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]300 &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]301 },
302 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]303 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
304 # user-facing error message should be localized and sent in the
305 # google.rpc.Status.details field, or localized by the client.
306 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]308 }</pre>
309</div>
310
311<div class="method">
312 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]313 <pre>Retrieves a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]314
315Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]316 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of
317the `Group` to retrieve.
318
319Must be of the form `groups/{group_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320 x__xgafv: string, V1 error format.
321 Allowed values
322 1 - v1 error format
323 2 - v2 error format
324
325Returns:
326 An object of the form:
327
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]328 { # A group within the Cloud Identity Groups API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]329 #
330 # A `Group` is a collection of entities, where each entity is either a user,
331 # another group or a service account.
332 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
333 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]334 #
335 # An entity can represent either a group with an optional `namespace` or a user
336 # without a `namespace`. The combination of `id` and `namespace` must be
337 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]338 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]339 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]340 # If not specified, the `EntityKey` represents a Google-managed entity such
341 # as a Google user or a Google Group.
342 #
343 # If specified, the `EntityKey` represents an external-identity-mapped group.
344 # The namespace must correspond to an identity source created in Admin
345 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]346 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]347 #
348 # For Google-managed entities, the `id` must be the email address of an
349 # existing group or user.
350 #
351 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]352 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]353 #
354 # Must be unique within a `namespace`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]355 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]356 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]358 # Must not be longer than 4,096 characters.
359 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
360 { # A unique identifier for an entity in the Cloud Identity Groups API.
361 #
362 # An entity can represent either a group with an optional `namespace` or a user
363 # without a `namespace`. The combination of `id` and `namespace` must be
364 # unique; however, the same `id` can be used with different `namespace`s.
365 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
366 #
367 # If not specified, the `EntityKey` represents a Google-managed entity such
368 # as a Google user or a Google Group.
369 #
370 # If specified, the `EntityKey` represents an external-identity-mapped group.
371 # The namespace must correspond to an identity source created in Admin
372 # Console and must be in the form of `identitysources/{identity_source_id}.
373 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
374 #
375 # For Google-managed entities, the `id` must be the email address of an
376 # existing group or user.
377 #
378 # For external-identity-mapped entities, the `id` must be a string conforming
379 # to the Identity Source&#x27;s requirements.
380 #
381 # Must be unique within a `namespace`.
382 },
383 ],
384 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
385 # Cloud Identity resource hierarchy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]386 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]387 # Must be of the form `identitysources/{identity_source_id}` for external-
388 # identity-mapped groups or `customers/{customer_id}` for Google Groups.
389 &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]390 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]391 # Must not contain more than one entry. Must contain the entry
392 # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
393 # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
394 # external-identity-mapped group.
395 &quot;a_key&quot;: &quot;A String&quot;,
396 },
397 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
398 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
399 # the `Group`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]400 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]401 # Shall be of the form `groups/{group_id}`.
402 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
403 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]404</div>
405
406<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]407 <code class="details" id="list">list(pageSize=None, view=None, parent=None, pageToken=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]408 <pre>Lists the `Group`s under a customer or namespace.
409
410Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]411 pageSize: integer, The maximum number of results to return.
412
413Note that the number of results returned may be less than this value even
414if there are more available results. To fetch all results, clients must
415continue calling this method repeatedly until the response no longer
416contains a `next_page_token`.
417
418If unspecified, defaults to 200 for `View.BASIC` and to 50 for `View.FULL`.
419
420Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`.
421 view: string, The level of detail to be returned.
422
423If unspecified, defaults to `View.BASIC`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]424 parent: string, Required. The parent resource under which to list all `Group`s.
425
426Must be of the form `identitysources/{identity_source_id}` for external-
427identity-mapped groups or `customers/{customer_id}` for Google Groups.
428 pageToken: string, The `next_page_token` value returned from a previous list request, if any.
429 x__xgafv: string, V1 error format.
430 Allowed values
431 1 - v1 error format
432 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]433
434Returns:
435 An object of the form:
436
437 { # The response message for GroupsService.ListGroups.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]438 &quot;nextPageToken&quot;: &quot;A String&quot;, # A continuation token to retrieve the next page of results, or empty if
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]439 # there are no more results available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]440 &quot;groups&quot;: [ # The `Group`s under the specified `parent`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]441 { # A group within the Cloud Identity Groups API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]442 #
443 # A `Group` is a collection of entities, where each entity is either a user,
444 # another group or a service account.
445 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
446 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]447 #
448 # An entity can represent either a group with an optional `namespace` or a user
449 # without a `namespace`. The combination of `id` and `namespace` must be
450 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]451 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]452 #
453 # If not specified, the `EntityKey` represents a Google-managed entity such
454 # as a Google user or a Google Group.
455 #
456 # If specified, the `EntityKey` represents an external-identity-mapped group.
457 # The namespace must correspond to an identity source created in Admin
458 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]459 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]460 #
461 # For Google-managed entities, the `id` must be the email address of an
462 # existing group or user.
463 #
464 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]465 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]466 #
467 # Must be unique within a `namespace`.
468 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]469 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
470 #
471 # Must not be longer than 4,096 characters.
472 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
473 { # A unique identifier for an entity in the Cloud Identity Groups API.
474 #
475 # An entity can represent either a group with an optional `namespace` or a user
476 # without a `namespace`. The combination of `id` and `namespace` must be
477 # unique; however, the same `id` can be used with different `namespace`s.
478 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
479 #
480 # If not specified, the `EntityKey` represents a Google-managed entity such
481 # as a Google user or a Google Group.
482 #
483 # If specified, the `EntityKey` represents an external-identity-mapped group.
484 # The namespace must correspond to an identity source created in Admin
485 # Console and must be in the form of `identitysources/{identity_source_id}.
486 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
487 #
488 # For Google-managed entities, the `id` must be the email address of an
489 # existing group or user.
490 #
491 # For external-identity-mapped entities, the `id` must be a string conforming
492 # to the Identity Source&#x27;s requirements.
493 #
494 # Must be unique within a `namespace`.
495 },
496 ],
497 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
498 # Cloud Identity resource hierarchy.
499 #
500 # Must be of the form `identitysources/{identity_source_id}` for external-
501 # identity-mapped groups or `customers/{customer_id}` for Google Groups.
502 &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
503 #
504 # Must not contain more than one entry. Must contain the entry
505 # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
506 # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
507 # external-identity-mapped group.
508 &quot;a_key&quot;: &quot;A String&quot;,
509 },
510 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
511 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
512 # the `Group`.
513 #
514 # Shall be of the form `groups/{group_id}`.
515 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]516 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]517 ],
518 }</pre>
519</div>
520
521<div class="method">
522 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
523 <pre>Retrieves the next page of results.
524
525Args:
526 previous_request: The request for the previous page. (required)
527 previous_response: The response from the request for the previous page. (required)
528
529Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]530 A request object that you can call &#x27;execute()&#x27; on to request the next
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]531 page. Returns None if there are no more items in the collection.
532 </pre>
533</div>
534
535<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]536 <code class="details" id="lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]537 <pre>Looks up the [resource
538name](https://cloud.google.com/apis/design/resource_names) of a `Group` by
539its `EntityKey`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]540
541Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]542 groupKey_id: string, The ID of the entity.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]543
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]544For Google-managed entities, the `id` must be the email address of an
545existing group or user.
546
547For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]548to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]549
550Must be unique within a `namespace`.
551 groupKey_namespace: string, The namespace in which the entity exists.
552
553If not specified, the `EntityKey` represents a Google-managed entity such
554as a Google user or a Google Group.
555
556If specified, the `EntityKey` represents an external-identity-mapped group.
557The namespace must correspond to an identity source created in Admin
558Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]559 x__xgafv: string, V1 error format.
560 Allowed values
561 1 - v1 error format
562 2 - v2 error format
563
564Returns:
565 An object of the form:
566
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]567 { # The response message for GroupsService.LookupGroupName.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]568 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]569 # the looked-up `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]570 }</pre>
571</div>
572
573<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]574 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
575 <pre>Updates a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]576
577Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]578 name: string, Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
579the `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]580
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]581Shall be of the form `groups/{group_id}`. (required)
582 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]583 The object takes the form of:
584
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]585{ # A group within the Cloud Identity Groups API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]586 #
587 # A `Group` is a collection of entities, where each entity is either a user,
588 # another group or a service account.
589 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
590 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]591 #
592 # An entity can represent either a group with an optional `namespace` or a user
593 # without a `namespace`. The combination of `id` and `namespace` must be
594 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]595 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]596 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]597 # If not specified, the `EntityKey` represents a Google-managed entity such
598 # as a Google user or a Google Group.
599 #
600 # If specified, the `EntityKey` represents an external-identity-mapped group.
601 # The namespace must correspond to an identity source created in Admin
602 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]603 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]604 #
605 # For Google-managed entities, the `id` must be the email address of an
606 # existing group or user.
607 #
608 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]609 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]610 #
611 # Must be unique within a `namespace`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]612 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]613 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
614 #
615 # Must not be longer than 4,096 characters.
616 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
617 { # A unique identifier for an entity in the Cloud Identity Groups API.
618 #
619 # An entity can represent either a group with an optional `namespace` or a user
620 # without a `namespace`. The combination of `id` and `namespace` must be
621 # unique; however, the same `id` can be used with different `namespace`s.
622 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
623 #
624 # If not specified, the `EntityKey` represents a Google-managed entity such
625 # as a Google user or a Google Group.
626 #
627 # If specified, the `EntityKey` represents an external-identity-mapped group.
628 # The namespace must correspond to an identity source created in Admin
629 # Console and must be in the form of `identitysources/{identity_source_id}.
630 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
631 #
632 # For Google-managed entities, the `id` must be the email address of an
633 # existing group or user.
634 #
635 # For external-identity-mapped entities, the `id` must be a string conforming
636 # to the Identity Source&#x27;s requirements.
637 #
638 # Must be unique within a `namespace`.
639 },
640 ],
641 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
642 # Cloud Identity resource hierarchy.
643 #
644 # Must be of the form `identitysources/{identity_source_id}` for external-
645 # identity-mapped groups or `customers/{customer_id}` for Google Groups.
646 &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
647 #
648 # Must not contain more than one entry. Must contain the entry
649 # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
650 # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
651 # external-identity-mapped group.
652 &quot;a_key&quot;: &quot;A String&quot;,
653 },
654 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
655 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
656 # the `Group`.
657 #
658 # Shall be of the form `groups/{group_id}`.
659 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
660 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]661
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]662 updateMask: string, Required. The fully-qualified names of fields to update.
663
664May only contain the following fields: `display_name`, `description`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]665 x__xgafv: string, V1 error format.
666 Allowed values
667 1 - v1 error format
668 2 - v2 error format
669
670Returns:
671 An object of the form:
672
673 { # This resource represents a long-running operation that is the result of a
674 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]675 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
676 # If `true`, the operation is completed, and either `error` or `response` is
677 # available.
678 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
679 # originally returns it. If you use the default HTTP mapping, the
680 # `name` should be a resource name ending with `operations/{unique_id}`.
681 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
682 # contains progress information and common metadata such as create time.
683 # Some services might not provide such metadata. Any method that returns a
684 # long-running operation should document the metadata type, if any.
685 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
686 },
687 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]688 # method returns no data on success, such as `Delete`, the response is
689 # `google.protobuf.Empty`. If the original method is standard
690 # `Get`/`Create`/`Update`, the response should be the resource. For other
691 # methods, the response should have the type `XxxResponse`, where `Xxx`
692 # is the original method name. For example, if the original method name
693 # is `TakeSnapshot()`, the inferred response type is
694 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]695 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]696 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]697 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]698 # different programming environments, including REST APIs and RPC APIs. It is
699 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
700 # three pieces of data: error code, error message, and error details.
701 #
702 # You can find out more about this error model and how to work with it in the
703 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]704 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]705 # message types for APIs to use.
706 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]707 &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]708 },
709 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]710 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
711 # user-facing error message should be localized and sent in the
712 # google.rpc.Status.details field, or localized by the client.
713 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]714 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]715 }</pre>
716</div>
717
718<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]719 <code class="details" id="search">search(view=None, pageToken=None, query=None, pageSize=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]720 <pre>Searches for `Group`s matching a specified query.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]721
722Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]723 view: string, The level of detail to be returned.
724
725If unspecified, defaults to `View.BASIC`.
726 pageToken: string, The `next_page_token` value returned from a previous search request, if
727any.
728 query: string, Required. The search query.
729
730Must be specified in [Common Expression
731Language](https://opensource.google/projects/cel). May only contain
732equality operators on the parent and inclusion operators on labels (e.g.,
733`parent == &#x27;customers/{customer_id}&#x27; &amp;&amp;
734&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27; in labels`).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]735 pageSize: integer, The maximum number of results to return.
736
737Note that the number of results returned may be less than this value even
738if there are more available results. To fetch all results, clients must
739continue calling this method repeatedly until the response no longer
740contains a `next_page_token`.
741
742If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for
743`GroupView.FULL`.
744
745Must not be greater than 1000 for `GroupView.BASIC` or 500 for
746`GroupView.FULL`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]747 x__xgafv: string, V1 error format.
748 Allowed values
749 1 - v1 error format
750 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]751
752Returns:
753 An object of the form:
754
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]755 { # The response message for GroupsService.SearchGroups.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]756 &quot;nextPageToken&quot;: &quot;A String&quot;, # A continuation token to retrieve the next page of results, or empty if
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]757 # there are no more results available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]758 &quot;groups&quot;: [ # The `Group`s that match the search query.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]759 { # A group within the Cloud Identity Groups API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]760 #
761 # A `Group` is a collection of entities, where each entity is either a user,
762 # another group or a service account.
763 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
764 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]765 #
766 # An entity can represent either a group with an optional `namespace` or a user
767 # without a `namespace`. The combination of `id` and `namespace` must be
768 # unique; however, the same `id` can be used with different `namespace`s.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]769 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]770 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]771 # If not specified, the `EntityKey` represents a Google-managed entity such
772 # as a Google user or a Google Group.
773 #
774 # If specified, the `EntityKey` represents an external-identity-mapped group.
775 # The namespace must correspond to an identity source created in Admin
776 # Console and must be in the form of `identitysources/{identity_source_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]777 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]778 #
779 # For Google-managed entities, the `id` must be the email address of an
780 # existing group or user.
781 #
782 # For external-identity-mapped entities, the `id` must be a string conforming
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]783 # to the Identity Source&#x27;s requirements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]784 #
785 # Must be unique within a `namespace`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]786 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]787 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
788 #
789 # Must not be longer than 4,096 characters.
790 &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
791 { # A unique identifier for an entity in the Cloud Identity Groups API.
792 #
793 # An entity can represent either a group with an optional `namespace` or a user
794 # without a `namespace`. The combination of `id` and `namespace` must be
795 # unique; however, the same `id` can be used with different `namespace`s.
796 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
797 #
798 # If not specified, the `EntityKey` represents a Google-managed entity such
799 # as a Google user or a Google Group.
800 #
801 # If specified, the `EntityKey` represents an external-identity-mapped group.
802 # The namespace must correspond to an identity source created in Admin
803 # Console and must be in the form of `identitysources/{identity_source_id}.
804 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
805 #
806 # For Google-managed entities, the `id` must be the email address of an
807 # existing group or user.
808 #
809 # For external-identity-mapped entities, the `id` must be a string conforming
810 # to the Identity Source&#x27;s requirements.
811 #
812 # Must be unique within a `namespace`.
813 },
814 ],
815 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
816 # Cloud Identity resource hierarchy.
817 #
818 # Must be of the form `identitysources/{identity_source_id}` for external-
819 # identity-mapped groups or `customers/{customer_id}` for Google Groups.
820 &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
821 #
822 # Must not contain more than one entry. Must contain the entry
823 # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
824 # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
825 # external-identity-mapped group.
826 &quot;a_key&quot;: &quot;A String&quot;,
827 },
828 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
829 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
830 # the `Group`.
831 #
832 # Shall be of the form `groups/{group_id}`.
833 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]834 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]835 ],
836 }</pre>
837</div>
838
839<div class="method">
840 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
841 <pre>Retrieves the next page of results.
842
843Args:
844 previous_request: The request for the previous page. (required)
845 previous_response: The response from the request for the previous page. (required)
846
847Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]848 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]849 page. Returns None if there are no more items in the collection.
850 </pre>
851</div>
852
853</body></html>