docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/cloudidentity_v1beta1.groups.html b/docs/dyn/cloudidentity_v1beta1.groups.html
index a0921de..c0f90a9 100644
--- a/docs/dyn/cloudidentity_v1beta1.groups.html
+++ b/docs/dyn/cloudidentity_v1beta1.groups.html
@@ -89,7 +89,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a `Group`.</p>
<p class="toc_element">
- <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None, view=None)</a></code></p>
+ <code><a href="#list">list(pageSize=None, view=None, parent=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the `Group`s under a customer or namespace.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -101,7 +101,7 @@
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a `Group`.</p>
<p class="toc_element">
- <code><a href="#search">search(pageSize=None, pageToken=None, query=None, x__xgafv=None, view=None)</a></code></p>
+ <code><a href="#search">search(view=None, pageToken=None, query=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches for `Group`s matching a specified query.</p>
<p class="toc_element">
<code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
@@ -116,17 +116,16 @@
The object takes the form of:
{ # A group within the Cloud Identity Groups API.
- #
- # A `Group` is a collection of entities, where each entity is either a user,
- # another group or a service account.
- "updateTime": "A String", # Output only. The time when the `Group` was last updated.
- "additionalGroupKeys": [ # Additional entity key aliases for a Group.
- { # A unique identifier for an entity in the Cloud Identity Groups API.
+ #
+ # A `Group` is a collection of entities, where each entity is either a user,
+ # another group or a service account.
+ "createTime": "A String", # Output only. The time when the `Group` was created.
+ "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
#
# An entity can represent either a group with an optional `namespace` or a user
# without a `namespace`. The combination of `id` and `namespace` must be
# unique; however, the same `id` can be used with different `namespace`s.
- "namespace": "A String", # The namespace in which the entity exists.
+ "namespace": "A String", # The namespace in which the entity exists.
#
# If not specified, the `EntityKey` represents a Google-managed entity such
# as a Google user or a Google Group.
@@ -134,63 +133,64 @@
# If specified, the `EntityKey` represents an external-identity-mapped group.
# The namespace must correspond to an identity source created in Admin
# Console and must be in the form of `identitysources/{identity_source_id}.
- "id": "A String", # The ID of the entity.
+ "id": "A String", # The ID of the entity.
#
# For Google-managed entities, the `id` must be the email address of an
# existing group or user.
#
# For external-identity-mapped entities, the `id` must be a string conforming
- # to the Identity Source's requirements.
+ # to the Identity Source's requirements.
#
# Must be unique within a `namespace`.
},
- ],
- "displayName": "A String", # The display name of the `Group`.
- "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
- # the `Group`.
- #
- # Shall be of the form `groups/{group_id}`.
- "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the
- # Cloud Identity resource hierarchy.
- #
- # Must be of the form `identitysources/{identity_source_id}` for external-
- # identity-mapped groups or `customers/{customer_id}` for Google Groups.
- "labels": { # Required. The labels that apply to the `Group`.
- #
- # Must not contain more than one entry. Must contain the entry
- # `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group`
- # is a Google Group or `'system/groups/external': ''` if the `Group` is an
- # external-identity-mapped group.
- "a_key": "A String",
- },
- "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
- #
- # An entity can represent either a group with an optional `namespace` or a user
- # without a `namespace`. The combination of `id` and `namespace` must be
- # unique; however, the same `id` can be used with different `namespace`s.
- "namespace": "A String", # The namespace in which the entity exists.
- #
- # If not specified, the `EntityKey` represents a Google-managed entity such
- # as a Google user or a Google Group.
- #
- # If specified, the `EntityKey` represents an external-identity-mapped group.
- # The namespace must correspond to an identity source created in Admin
- # Console and must be in the form of `identitysources/{identity_source_id}.
- "id": "A String", # The ID of the entity.
- #
- # For Google-managed entities, the `id` must be the email address of an
- # existing group or user.
- #
- # For external-identity-mapped entities, the `id` must be a string conforming
- # to the Identity Source's requirements.
- #
- # Must be unique within a `namespace`.
- },
- "createTime": "A String", # Output only. The time when the `Group` was created.
- "description": "A String", # An extended description to help users determine the purpose of a `Group`.
- #
- # Must not be longer than 4,096 characters.
-}
+ "description": "A String", # An extended description to help users determine the purpose of a `Group`.
+ #
+ # Must not be longer than 4,096 characters.
+ "additionalGroupKeys": [ # Additional entity key aliases for a Group.
+ { # A unique identifier for an entity in the Cloud Identity Groups API.
+ #
+ # An entity can represent either a group with an optional `namespace` or a user
+ # without a `namespace`. The combination of `id` and `namespace` must be
+ # unique; however, the same `id` can be used with different `namespace`s.
+ "namespace": "A String", # The namespace in which the entity exists.
+ #
+ # If not specified, the `EntityKey` represents a Google-managed entity such
+ # as a Google user or a Google Group.
+ #
+ # If specified, the `EntityKey` represents an external-identity-mapped group.
+ # The namespace must correspond to an identity source created in Admin
+ # Console and must be in the form of `identitysources/{identity_source_id}.
+ "id": "A String", # The ID of the entity.
+ #
+ # For Google-managed entities, the `id` must be the email address of an
+ # existing group or user.
+ #
+ # For external-identity-mapped entities, the `id` must be a string conforming
+ # to the Identity Source's requirements.
+ #
+ # Must be unique within a `namespace`.
+ },
+ ],
+ "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the
+ # Cloud Identity resource hierarchy.
+ #
+ # Must be of the form `identitysources/{identity_source_id}` for external-
+ # identity-mapped groups or `customers/{customer_id}` for Google Groups.
+ "labels": { # Required. The labels that apply to the `Group`.
+ #
+ # Must not contain more than one entry. Must contain the entry
+ # `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group`
+ # is a Google Group or `'system/groups/external': ''` if the `Group` is an
+ # external-identity-mapped group.
+ "a_key": "A String",
+ },
+ "updateTime": "A String", # Output only. The time when the `Group` was last updated.
+ "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
+ # the `Group`.
+ #
+ # Shall be of the form `groups/{group_id}`.
+ "displayName": "A String", # The display name of the `Group`.
+ }
initialGroupConfig: string, Required. The initial configuration option for the `Group`.
x__xgafv: string, V1 error format.
@@ -203,7 +203,19 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "done": 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.
+ "name": "A String", # 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}`.
+ "metadata": { # 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "response": { # 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
@@ -211,37 +223,25 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "metadata": { # 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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "done": 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.
- "name": "A String", # 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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# 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).
- "message": "A String", # 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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "message": "A String", # 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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
}</pre>
</div>
@@ -265,7 +265,19 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "done": 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.
+ "name": "A String", # 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}`.
+ "metadata": { # 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "response": { # 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
@@ -273,37 +285,25 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "metadata": { # 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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "done": 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.
- "name": "A String", # 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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# 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).
- "message": "A String", # 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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "message": "A String", # 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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
}</pre>
</div>
@@ -326,17 +326,16 @@
An object of the form:
{ # A group within the Cloud Identity Groups API.
- #
- # A `Group` is a collection of entities, where each entity is either a user,
- # another group or a service account.
- "updateTime": "A String", # Output only. The time when the `Group` was last updated.
- "additionalGroupKeys": [ # Additional entity key aliases for a Group.
- { # A unique identifier for an entity in the Cloud Identity Groups API.
+ #
+ # A `Group` is a collection of entities, where each entity is either a user,
+ # another group or a service account.
+ "createTime": "A String", # Output only. The time when the `Group` was created.
+ "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
#
# An entity can represent either a group with an optional `namespace` or a user
# without a `namespace`. The combination of `id` and `namespace` must be
# unique; however, the same `id` can be used with different `namespace`s.
- "namespace": "A String", # The namespace in which the entity exists.
+ "namespace": "A String", # The namespace in which the entity exists.
#
# If not specified, the `EntityKey` represents a Google-managed entity such
# as a Google user or a Google Group.
@@ -344,79 +343,71 @@
# If specified, the `EntityKey` represents an external-identity-mapped group.
# The namespace must correspond to an identity source created in Admin
# Console and must be in the form of `identitysources/{identity_source_id}.
- "id": "A String", # The ID of the entity.
+ "id": "A String", # The ID of the entity.
#
# For Google-managed entities, the `id` must be the email address of an
# existing group or user.
#
# For external-identity-mapped entities, the `id` must be a string conforming
- # to the Identity Source's requirements.
+ # to the Identity Source's requirements.
#
# Must be unique within a `namespace`.
},
- ],
- "displayName": "A String", # The display name of the `Group`.
- "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
- # the `Group`.
- #
- # Shall be of the form `groups/{group_id}`.
- "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the
- # Cloud Identity resource hierarchy.
- #
- # Must be of the form `identitysources/{identity_source_id}` for external-
- # identity-mapped groups or `customers/{customer_id}` for Google Groups.
- "labels": { # Required. The labels that apply to the `Group`.
- #
- # Must not contain more than one entry. Must contain the entry
- # `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group`
- # is a Google Group or `'system/groups/external': ''` if the `Group` is an
- # external-identity-mapped group.
- "a_key": "A String",
- },
- "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
- #
- # An entity can represent either a group with an optional `namespace` or a user
- # without a `namespace`. The combination of `id` and `namespace` must be
- # unique; however, the same `id` can be used with different `namespace`s.
- "namespace": "A String", # The namespace in which the entity exists.
+ "description": "A String", # An extended description to help users determine the purpose of a `Group`.
#
- # If not specified, the `EntityKey` represents a Google-managed entity such
- # as a Google user or a Google Group.
+ # Must not be longer than 4,096 characters.
+ "additionalGroupKeys": [ # Additional entity key aliases for a Group.
+ { # A unique identifier for an entity in the Cloud Identity Groups API.
+ #
+ # An entity can represent either a group with an optional `namespace` or a user
+ # without a `namespace`. The combination of `id` and `namespace` must be
+ # unique; however, the same `id` can be used with different `namespace`s.
+ "namespace": "A String", # The namespace in which the entity exists.
+ #
+ # If not specified, the `EntityKey` represents a Google-managed entity such
+ # as a Google user or a Google Group.
+ #
+ # If specified, the `EntityKey` represents an external-identity-mapped group.
+ # The namespace must correspond to an identity source created in Admin
+ # Console and must be in the form of `identitysources/{identity_source_id}.
+ "id": "A String", # The ID of the entity.
+ #
+ # For Google-managed entities, the `id` must be the email address of an
+ # existing group or user.
+ #
+ # For external-identity-mapped entities, the `id` must be a string conforming
+ # to the Identity Source's requirements.
+ #
+ # Must be unique within a `namespace`.
+ },
+ ],
+ "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the
+ # Cloud Identity resource hierarchy.
#
- # If specified, the `EntityKey` represents an external-identity-mapped group.
- # The namespace must correspond to an identity source created in Admin
- # Console and must be in the form of `identitysources/{identity_source_id}.
- "id": "A String", # The ID of the entity.
+ # Must be of the form `identitysources/{identity_source_id}` for external-
+ # identity-mapped groups or `customers/{customer_id}` for Google Groups.
+ "labels": { # Required. The labels that apply to the `Group`.
#
- # For Google-managed entities, the `id` must be the email address of an
- # existing group or user.
+ # Must not contain more than one entry. Must contain the entry
+ # `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group`
+ # is a Google Group or `'system/groups/external': ''` if the `Group` is an
+ # external-identity-mapped group.
+ "a_key": "A String",
+ },
+ "updateTime": "A String", # Output only. The time when the `Group` was last updated.
+ "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
+ # the `Group`.
#
- # For external-identity-mapped entities, the `id` must be a string conforming
- # to the Identity Source's requirements.
- #
- # Must be unique within a `namespace`.
- },
- "createTime": "A String", # Output only. The time when the `Group` was created.
- "description": "A String", # An extended description to help users determine the purpose of a `Group`.
- #
- # Must not be longer than 4,096 characters.
- }</pre>
+ # Shall be of the form `groups/{group_id}`.
+ "displayName": "A String", # The display name of the `Group`.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None, view=None)</code>
+ <code class="details" id="list">list(pageSize=None, view=None, parent=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the `Group`s under a customer or namespace.
Args:
- parent: string, Required. The parent resource under which to list all `Group`s.
-
-Must be of the form `identitysources/{identity_source_id}` for external-
-identity-mapped groups or `customers/{customer_id}` for Google Groups.
- pageToken: string, The `next_page_token` value returned from a previous list request, if any.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
pageSize: integer, The maximum number of results to return.
Note that the number of results returned may be less than this value even
@@ -430,26 +421,34 @@
view: string, The level of detail to be returned.
If unspecified, defaults to `View.BASIC`.
+ parent: string, Required. The parent resource under which to list all `Group`s.
+
+Must be of the form `identitysources/{identity_source_id}` for external-
+identity-mapped groups or `customers/{customer_id}` for Google Groups.
+ pageToken: string, The `next_page_token` value returned from a previous list request, if any.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # The response message for GroupsService.ListGroups.
- "nextPageToken": "A String", # A continuation token to retrieve the next page of results, or empty if
+ "nextPageToken": "A String", # A continuation token to retrieve the next page of results, or empty if
# there are no more results available.
- "groups": [ # The `Group`s under the specified `parent`.
+ "groups": [ # The `Group`s under the specified `parent`.
{ # A group within the Cloud Identity Groups API.
- #
- # A `Group` is a collection of entities, where each entity is either a user,
- # another group or a service account.
- "updateTime": "A String", # Output only. The time when the `Group` was last updated.
- "additionalGroupKeys": [ # Additional entity key aliases for a Group.
- { # A unique identifier for an entity in the Cloud Identity Groups API.
+ #
+ # A `Group` is a collection of entities, where each entity is either a user,
+ # another group or a service account.
+ "createTime": "A String", # Output only. The time when the `Group` was created.
+ "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
#
# An entity can represent either a group with an optional `namespace` or a user
# without a `namespace`. The combination of `id` and `namespace` must be
# unique; however, the same `id` can be used with different `namespace`s.
- "namespace": "A String", # The namespace in which the entity exists.
+ "namespace": "A String", # The namespace in which the entity exists.
#
# If not specified, the `EntityKey` represents a Google-managed entity such
# as a Google user or a Google Group.
@@ -457,63 +456,64 @@
# If specified, the `EntityKey` represents an external-identity-mapped group.
# The namespace must correspond to an identity source created in Admin
# Console and must be in the form of `identitysources/{identity_source_id}.
- "id": "A String", # The ID of the entity.
+ "id": "A String", # The ID of the entity.
#
# For Google-managed entities, the `id` must be the email address of an
# existing group or user.
#
# For external-identity-mapped entities, the `id` must be a string conforming
- # to the Identity Source's requirements.
+ # to the Identity Source's requirements.
#
# Must be unique within a `namespace`.
},
- ],
- "displayName": "A String", # The display name of the `Group`.
- "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
- # the `Group`.
- #
- # Shall be of the form `groups/{group_id}`.
- "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the
- # Cloud Identity resource hierarchy.
- #
- # Must be of the form `identitysources/{identity_source_id}` for external-
- # identity-mapped groups or `customers/{customer_id}` for Google Groups.
- "labels": { # Required. The labels that apply to the `Group`.
- #
- # Must not contain more than one entry. Must contain the entry
- # `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group`
- # is a Google Group or `'system/groups/external': ''` if the `Group` is an
- # external-identity-mapped group.
- "a_key": "A String",
+ "description": "A String", # An extended description to help users determine the purpose of a `Group`.
+ #
+ # Must not be longer than 4,096 characters.
+ "additionalGroupKeys": [ # Additional entity key aliases for a Group.
+ { # A unique identifier for an entity in the Cloud Identity Groups API.
+ #
+ # An entity can represent either a group with an optional `namespace` or a user
+ # without a `namespace`. The combination of `id` and `namespace` must be
+ # unique; however, the same `id` can be used with different `namespace`s.
+ "namespace": "A String", # The namespace in which the entity exists.
+ #
+ # If not specified, the `EntityKey` represents a Google-managed entity such
+ # as a Google user or a Google Group.
+ #
+ # If specified, the `EntityKey` represents an external-identity-mapped group.
+ # The namespace must correspond to an identity source created in Admin
+ # Console and must be in the form of `identitysources/{identity_source_id}.
+ "id": "A String", # The ID of the entity.
+ #
+ # For Google-managed entities, the `id` must be the email address of an
+ # existing group or user.
+ #
+ # For external-identity-mapped entities, the `id` must be a string conforming
+ # to the Identity Source's requirements.
+ #
+ # Must be unique within a `namespace`.
+ },
+ ],
+ "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the
+ # Cloud Identity resource hierarchy.
+ #
+ # Must be of the form `identitysources/{identity_source_id}` for external-
+ # identity-mapped groups or `customers/{customer_id}` for Google Groups.
+ "labels": { # Required. The labels that apply to the `Group`.
+ #
+ # Must not contain more than one entry. Must contain the entry
+ # `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group`
+ # is a Google Group or `'system/groups/external': ''` if the `Group` is an
+ # external-identity-mapped group.
+ "a_key": "A String",
+ },
+ "updateTime": "A String", # Output only. The time when the `Group` was last updated.
+ "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
+ # the `Group`.
+ #
+ # Shall be of the form `groups/{group_id}`.
+ "displayName": "A String", # The display name of the `Group`.
},
- "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
- #
- # An entity can represent either a group with an optional `namespace` or a user
- # without a `namespace`. The combination of `id` and `namespace` must be
- # unique; however, the same `id` can be used with different `namespace`s.
- "namespace": "A String", # The namespace in which the entity exists.
- #
- # If not specified, the `EntityKey` represents a Google-managed entity such
- # as a Google user or a Google Group.
- #
- # If specified, the `EntityKey` represents an external-identity-mapped group.
- # The namespace must correspond to an identity source created in Admin
- # Console and must be in the form of `identitysources/{identity_source_id}.
- "id": "A String", # The ID of the entity.
- #
- # For Google-managed entities, the `id` must be the email address of an
- # existing group or user.
- #
- # For external-identity-mapped entities, the `id` must be a string conforming
- # to the Identity Source's requirements.
- #
- # Must be unique within a `namespace`.
- },
- "createTime": "A String", # Output only. The time when the `Group` was created.
- "description": "A String", # An extended description to help users determine the purpose of a `Group`.
- #
- # Must not be longer than 4,096 characters.
- },
],
}</pre>
</div>
@@ -527,7 +527,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -545,7 +545,7 @@
existing group or user.
For external-identity-mapped entities, the `id` must be a string conforming
-to the Identity Source's requirements.
+to the Identity Source's requirements.
Must be unique within a `namespace`.
groupKey_namespace: string, The namespace in which the entity exists.
@@ -565,7 +565,7 @@
An object of the form:
{ # The response message for GroupsService.LookupGroupName.
- "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
+ "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
# the looked-up `Group`.
}</pre>
</div>
@@ -583,17 +583,16 @@
The object takes the form of:
{ # A group within the Cloud Identity Groups API.
- #
- # A `Group` is a collection of entities, where each entity is either a user,
- # another group or a service account.
- "updateTime": "A String", # Output only. The time when the `Group` was last updated.
- "additionalGroupKeys": [ # Additional entity key aliases for a Group.
- { # A unique identifier for an entity in the Cloud Identity Groups API.
+ #
+ # A `Group` is a collection of entities, where each entity is either a user,
+ # another group or a service account.
+ "createTime": "A String", # Output only. The time when the `Group` was created.
+ "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
#
# An entity can represent either a group with an optional `namespace` or a user
# without a `namespace`. The combination of `id` and `namespace` must be
# unique; however, the same `id` can be used with different `namespace`s.
- "namespace": "A String", # The namespace in which the entity exists.
+ "namespace": "A String", # The namespace in which the entity exists.
#
# If not specified, the `EntityKey` represents a Google-managed entity such
# as a Google user or a Google Group.
@@ -601,63 +600,64 @@
# If specified, the `EntityKey` represents an external-identity-mapped group.
# The namespace must correspond to an identity source created in Admin
# Console and must be in the form of `identitysources/{identity_source_id}.
- "id": "A String", # The ID of the entity.
+ "id": "A String", # The ID of the entity.
#
# For Google-managed entities, the `id` must be the email address of an
# existing group or user.
#
# For external-identity-mapped entities, the `id` must be a string conforming
- # to the Identity Source's requirements.
+ # to the Identity Source's requirements.
#
# Must be unique within a `namespace`.
},
- ],
- "displayName": "A String", # The display name of the `Group`.
- "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
- # the `Group`.
- #
- # Shall be of the form `groups/{group_id}`.
- "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the
- # Cloud Identity resource hierarchy.
- #
- # Must be of the form `identitysources/{identity_source_id}` for external-
- # identity-mapped groups or `customers/{customer_id}` for Google Groups.
- "labels": { # Required. The labels that apply to the `Group`.
- #
- # Must not contain more than one entry. Must contain the entry
- # `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group`
- # is a Google Group or `'system/groups/external': ''` if the `Group` is an
- # external-identity-mapped group.
- "a_key": "A String",
- },
- "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
- #
- # An entity can represent either a group with an optional `namespace` or a user
- # without a `namespace`. The combination of `id` and `namespace` must be
- # unique; however, the same `id` can be used with different `namespace`s.
- "namespace": "A String", # The namespace in which the entity exists.
- #
- # If not specified, the `EntityKey` represents a Google-managed entity such
- # as a Google user or a Google Group.
- #
- # If specified, the `EntityKey` represents an external-identity-mapped group.
- # The namespace must correspond to an identity source created in Admin
- # Console and must be in the form of `identitysources/{identity_source_id}.
- "id": "A String", # The ID of the entity.
- #
- # For Google-managed entities, the `id` must be the email address of an
- # existing group or user.
- #
- # For external-identity-mapped entities, the `id` must be a string conforming
- # to the Identity Source's requirements.
- #
- # Must be unique within a `namespace`.
- },
- "createTime": "A String", # Output only. The time when the `Group` was created.
- "description": "A String", # An extended description to help users determine the purpose of a `Group`.
- #
- # Must not be longer than 4,096 characters.
-}
+ "description": "A String", # An extended description to help users determine the purpose of a `Group`.
+ #
+ # Must not be longer than 4,096 characters.
+ "additionalGroupKeys": [ # Additional entity key aliases for a Group.
+ { # A unique identifier for an entity in the Cloud Identity Groups API.
+ #
+ # An entity can represent either a group with an optional `namespace` or a user
+ # without a `namespace`. The combination of `id` and `namespace` must be
+ # unique; however, the same `id` can be used with different `namespace`s.
+ "namespace": "A String", # The namespace in which the entity exists.
+ #
+ # If not specified, the `EntityKey` represents a Google-managed entity such
+ # as a Google user or a Google Group.
+ #
+ # If specified, the `EntityKey` represents an external-identity-mapped group.
+ # The namespace must correspond to an identity source created in Admin
+ # Console and must be in the form of `identitysources/{identity_source_id}.
+ "id": "A String", # The ID of the entity.
+ #
+ # For Google-managed entities, the `id` must be the email address of an
+ # existing group or user.
+ #
+ # For external-identity-mapped entities, the `id` must be a string conforming
+ # to the Identity Source's requirements.
+ #
+ # Must be unique within a `namespace`.
+ },
+ ],
+ "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the
+ # Cloud Identity resource hierarchy.
+ #
+ # Must be of the form `identitysources/{identity_source_id}` for external-
+ # identity-mapped groups or `customers/{customer_id}` for Google Groups.
+ "labels": { # Required. The labels that apply to the `Group`.
+ #
+ # Must not contain more than one entry. Must contain the entry
+ # `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group`
+ # is a Google Group or `'system/groups/external': ''` if the `Group` is an
+ # external-identity-mapped group.
+ "a_key": "A String",
+ },
+ "updateTime": "A String", # Output only. The time when the `Group` was last updated.
+ "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
+ # the `Group`.
+ #
+ # Shall be of the form `groups/{group_id}`.
+ "displayName": "A String", # The display name of the `Group`.
+ }
updateMask: string, Required. The fully-qualified names of fields to update.
@@ -672,7 +672,19 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "done": 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.
+ "name": "A String", # 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}`.
+ "metadata": { # 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "response": { # 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
@@ -680,46 +692,46 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "metadata": { # 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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "done": 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.
- "name": "A String", # 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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# 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).
- "message": "A String", # 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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "message": "A String", # 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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
}</pre>
</div>
<div class="method">
- <code class="details" id="search">search(pageSize=None, pageToken=None, query=None, x__xgafv=None, view=None)</code>
+ <code class="details" id="search">search(view=None, pageToken=None, query=None, pageSize=None, x__xgafv=None)</code>
<pre>Searches for `Group`s matching a specified query.
Args:
+ view: string, The level of detail to be returned.
+
+If unspecified, defaults to `View.BASIC`.
+ pageToken: string, The `next_page_token` value returned from a previous search request, if
+any.
+ query: string, Required. The search query.
+
+Must be specified in [Common Expression
+Language](https://opensource.google/projects/cel). May only contain
+equality operators on the parent and inclusion operators on labels (e.g.,
+`parent == 'customers/{customer_id}' &&
+'cloudidentity.googleapis.com/groups.discussion_forum' in labels`).
pageSize: integer, The maximum number of results to return.
Note that the number of results returned may be less than this value even
@@ -732,42 +744,29 @@
Must not be greater than 1000 for `GroupView.BASIC` or 500 for
`GroupView.FULL`.
- pageToken: string, The `next_page_token` value returned from a previous search request, if
-any.
- query: string, Required. The search query.
-
-Must be specified in [Common Expression
-Language](https://opensource.google/projects/cel). May only contain
-equality operators on the parent and inclusion operators on labels (e.g.,
-`parent == 'customers/{customer_id}' &&
-'cloudidentity.googleapis.com/groups.discussion_forum' in labels`).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- view: string, The level of detail to be returned.
-
-If unspecified, defaults to `View.BASIC`.
Returns:
An object of the form:
{ # The response message for GroupsService.SearchGroups.
- "nextPageToken": "A String", # A continuation token to retrieve the next page of results, or empty if
+ "nextPageToken": "A String", # A continuation token to retrieve the next page of results, or empty if
# there are no more results available.
- "groups": [ # The `Group`s that match the search query.
+ "groups": [ # The `Group`s that match the search query.
{ # A group within the Cloud Identity Groups API.
- #
- # A `Group` is a collection of entities, where each entity is either a user,
- # another group or a service account.
- "updateTime": "A String", # Output only. The time when the `Group` was last updated.
- "additionalGroupKeys": [ # Additional entity key aliases for a Group.
- { # A unique identifier for an entity in the Cloud Identity Groups API.
+ #
+ # A `Group` is a collection of entities, where each entity is either a user,
+ # another group or a service account.
+ "createTime": "A String", # Output only. The time when the `Group` was created.
+ "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
#
# An entity can represent either a group with an optional `namespace` or a user
# without a `namespace`. The combination of `id` and `namespace` must be
# unique; however, the same `id` can be used with different `namespace`s.
- "namespace": "A String", # The namespace in which the entity exists.
+ "namespace": "A String", # The namespace in which the entity exists.
#
# If not specified, the `EntityKey` represents a Google-managed entity such
# as a Google user or a Google Group.
@@ -775,63 +774,64 @@
# If specified, the `EntityKey` represents an external-identity-mapped group.
# The namespace must correspond to an identity source created in Admin
# Console and must be in the form of `identitysources/{identity_source_id}.
- "id": "A String", # The ID of the entity.
+ "id": "A String", # The ID of the entity.
#
# For Google-managed entities, the `id` must be the email address of an
# existing group or user.
#
# For external-identity-mapped entities, the `id` must be a string conforming
- # to the Identity Source's requirements.
+ # to the Identity Source's requirements.
#
# Must be unique within a `namespace`.
},
- ],
- "displayName": "A String", # The display name of the `Group`.
- "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
- # the `Group`.
- #
- # Shall be of the form `groups/{group_id}`.
- "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the
- # Cloud Identity resource hierarchy.
- #
- # Must be of the form `identitysources/{identity_source_id}` for external-
- # identity-mapped groups or `customers/{customer_id}` for Google Groups.
- "labels": { # Required. The labels that apply to the `Group`.
- #
- # Must not contain more than one entry. Must contain the entry
- # `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group`
- # is a Google Group or `'system/groups/external': ''` if the `Group` is an
- # external-identity-mapped group.
- "a_key": "A String",
+ "description": "A String", # An extended description to help users determine the purpose of a `Group`.
+ #
+ # Must not be longer than 4,096 characters.
+ "additionalGroupKeys": [ # Additional entity key aliases for a Group.
+ { # A unique identifier for an entity in the Cloud Identity Groups API.
+ #
+ # An entity can represent either a group with an optional `namespace` or a user
+ # without a `namespace`. The combination of `id` and `namespace` must be
+ # unique; however, the same `id` can be used with different `namespace`s.
+ "namespace": "A String", # The namespace in which the entity exists.
+ #
+ # If not specified, the `EntityKey` represents a Google-managed entity such
+ # as a Google user or a Google Group.
+ #
+ # If specified, the `EntityKey` represents an external-identity-mapped group.
+ # The namespace must correspond to an identity source created in Admin
+ # Console and must be in the form of `identitysources/{identity_source_id}.
+ "id": "A String", # The ID of the entity.
+ #
+ # For Google-managed entities, the `id` must be the email address of an
+ # existing group or user.
+ #
+ # For external-identity-mapped entities, the `id` must be a string conforming
+ # to the Identity Source's requirements.
+ #
+ # Must be unique within a `namespace`.
+ },
+ ],
+ "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the
+ # Cloud Identity resource hierarchy.
+ #
+ # Must be of the form `identitysources/{identity_source_id}` for external-
+ # identity-mapped groups or `customers/{customer_id}` for Google Groups.
+ "labels": { # Required. The labels that apply to the `Group`.
+ #
+ # Must not contain more than one entry. Must contain the entry
+ # `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group`
+ # is a Google Group or `'system/groups/external': ''` if the `Group` is an
+ # external-identity-mapped group.
+ "a_key": "A String",
+ },
+ "updateTime": "A String", # Output only. The time when the `Group` was last updated.
+ "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
+ # the `Group`.
+ #
+ # Shall be of the form `groups/{group_id}`.
+ "displayName": "A String", # The display name of the `Group`.
},
- "groupKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
- #
- # An entity can represent either a group with an optional `namespace` or a user
- # without a `namespace`. The combination of `id` and `namespace` must be
- # unique; however, the same `id` can be used with different `namespace`s.
- "namespace": "A String", # The namespace in which the entity exists.
- #
- # If not specified, the `EntityKey` represents a Google-managed entity such
- # as a Google user or a Google Group.
- #
- # If specified, the `EntityKey` represents an external-identity-mapped group.
- # The namespace must correspond to an identity source created in Admin
- # Console and must be in the form of `identitysources/{identity_source_id}.
- "id": "A String", # The ID of the entity.
- #
- # For Google-managed entities, the `id` must be the email address of an
- # existing group or user.
- #
- # For external-identity-mapped entities, the `id` must be a string conforming
- # to the Identity Source's requirements.
- #
- # Must be unique within a `namespace`.
- },
- "createTime": "A String", # Output only. The time when the `Group` was created.
- "description": "A String", # An extended description to help users determine the purpose of a `Group`.
- #
- # Must not be longer than 4,096 characters.
- },
],
}</pre>
</div>
@@ -845,7 +845,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>