chore: regens API reference docs (#889)
diff --git a/docs/dyn/cloudidentity_v1beta1.groups.memberships.html b/docs/dyn/cloudidentity_v1beta1.groups.memberships.html
index fda4154..8e6a386 100644
--- a/docs/dyn/cloudidentity_v1beta1.groups.memberships.html
+++ b/docs/dyn/cloudidentity_v1beta1.groups.memberships.html
@@ -75,69 +75,116 @@
<h1><a href="cloudidentity_v1beta1.html">Cloud Identity API</a> . <a href="cloudidentity_v1beta1.groups.html">groups</a> . <a href="cloudidentity_v1beta1.groups.memberships.html">memberships</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a Membership.</p>
+ <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a `Membership`.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a Membership.</p>
+<p class="firstline">Deletes a `Membership`.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Retrieves a Membership.</p>
+<p class="firstline">Retrieves a `Membership`.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, view=None)</a></code></p>
-<p class="firstline">List Memberships within a Group.</p>
+ <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, view=None)</a></code></p>
+<p class="firstline">Lists the `Membership`s within a `Group`.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#lookup">lookup(parent, memberKey_namespace=None, memberKey_id=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Looks up [resource</p>
+<p class="firstline">Looks up the [resource</p>
+<p class="toc_element">
+ <code><a href="#modifyMembershipRoles">modifyMembershipRoles(name, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Modifies the `MembershipRole`s of a `Membership`.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
- <pre>Creates a Membership.
+ <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
+ <pre>Creates a `Membership`.
Args:
- parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the
-Group to create Membership within. Format: `groups/{group_id}`, where
-`group_id` is the unique id assigned to the Group. (required)
- body: object, The request body. (required)
+ parent: string, Required. The parent `Group` resource under which to create the `Membership`.
+
+Must be of the form `groups/{group_id}`. (required)
+ body: object, The request body.
The object takes the form of:
-{ # Resource representing a Membership within a Group
- "roles": [ # Roles for a member within the Group.
- #
- # Currently supported MembershipRoles: `"MEMBER"`.
- { # Resource representing a role within a Membership.
- "name": "A String", # MembershipRole in string format.
- #
- # Currently supported MembershipRoles: `"MEMBER"`.
- },
- ],
- "memberKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # EntityKey of the entity to be added as the member. Must be set while
- # creating a Membership, read-only afterwards.
- #
- # Currently allowed entity types: `Users`, `Groups`.
- # isolation for ids. A single Id can be reused across namespaces but the
- # combination of a namespace and an id must be unique.
- "namespace": "A String", # Namespaces provide isolation for ids, i.e an id only needs to be unique
- # within its namespace.
+{ # A membership within the Cloud Identity Groups API.
+ #
+ # A `Membership` defines a relationship between a `Group` and an entity
+ # belonging to that `Group`, referred to as a "member".
+ "updateTime": "A String", # Output only. The time when the `Membership` was last updated.
+ "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
+ # the `Membership`.
+ #
+ # Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
+ "roles": [ # The `MembershipRole`s that apply to the `Membership`.
+ #
+ # If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`.
+ #
+ # Must not contain duplicate `MembershipRole`s with the same `name`.
+ { # A membership role within the Cloud Identity Groups API.
+ #
+ # A `MembershipRole` defines the privileges granted to a `Membership`.
+ "name": "A String", # The name of the `MembershipRole`.
#
- # Namespaces are currently only created as part of IdentitySource creation
- # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
- # created corresponding to every Identity Source `identity_source_id`.
- "id": "A String", # The id of the entity within the given namespace. The id must be unique
- # within its namespace.
+ # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
},
- "createTime": "A String", # Creation timestamp of the Membership.
- "updateTime": "A String", # Last updated timestamp of the Membership.
- "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the
- # Membership in the format: `groups/{group_id}/memberships/{member_id}`,
- # where group_id is the unique id assigned to the Group to which Membership
- # belongs to, and member_id is the unique id assigned to the member
- #
- # Must be left blank while creating a Membership.
- }
+ ],
+ "memberKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Immutable. The `EntityKey` of the member.
+ #
+ # Either `member_key` or `preferred_member_key` must be set when calling
+ # MembershipsService.CreateMembership but not both; both shall be set
+ # when returned.
+ #
+ # 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`.
+ },
+ "preferredMemberKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the member.
+ #
+ # Either `member_key` or `preferred_member_key` must be set when calling
+ # MembershipsService.CreateMembership but not both; both shall be set
+ # when returned.
+ #
+ # 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 `Membership` was created.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -149,6 +196,28 @@
{ # 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
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "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.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -167,42 +236,18 @@
},
],
},
- "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.
- "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
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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.
- },
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
- <pre>Deletes a Membership.
+ <pre>Deletes a `Membership`.
Args:
- name: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the
-Membership to be deleted.
+ name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of
+the `Membership` to delete.
-Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is
-the unique id assigned to the Group to which Membership belongs to, and
-member_id is the unique id assigned to the member. (required)
+Must be of the form `groups/{group_id}/memberships/{membership_id}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -213,6 +258,28 @@
{ # 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
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "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.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -231,42 +298,18 @@
},
],
},
- "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.
- "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
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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.
- },
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
- <pre>Retrieves a Membership.
+ <pre>Retrieves a `Membership`.
Args:
- name: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the
-Membership to be retrieved.
+ name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of
+the `Membership` to retrieve.
-Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is
-the unique id assigned to the Group to which Membership belongs to, and
-`member_id` is the unique id assigned to the member. (required)
+Must be of the form `groups/{group_id}/memberships/{membership_id}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -275,103 +318,202 @@
Returns:
An object of the form:
- { # Resource representing a Membership within a Group
- "roles": [ # Roles for a member within the Group.
+ { # A membership within the Cloud Identity Groups API.
+ #
+ # A `Membership` defines a relationship between a `Group` and an entity
+ # belonging to that `Group`, referred to as a "member".
+ "updateTime": "A String", # Output only. The time when the `Membership` was last updated.
+ "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
+ # the `Membership`.
+ #
+ # Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
+ "roles": [ # The `MembershipRole`s that apply to the `Membership`.
+ #
+ # If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`.
+ #
+ # Must not contain duplicate `MembershipRole`s with the same `name`.
+ { # A membership role within the Cloud Identity Groups API.
#
- # Currently supported MembershipRoles: `"MEMBER"`.
- { # Resource representing a role within a Membership.
- "name": "A String", # MembershipRole in string format.
- #
- # Currently supported MembershipRoles: `"MEMBER"`.
- },
- ],
- "memberKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # EntityKey of the entity to be added as the member. Must be set while
- # creating a Membership, read-only afterwards.
- #
- # Currently allowed entity types: `Users`, `Groups`.
- # isolation for ids. A single Id can be reused across namespaces but the
- # combination of a namespace and an id must be unique.
- "namespace": "A String", # Namespaces provide isolation for ids, i.e an id only needs to be unique
- # within its namespace.
+ # A `MembershipRole` defines the privileges granted to a `Membership`.
+ "name": "A String", # The name of the `MembershipRole`.
#
- # Namespaces are currently only created as part of IdentitySource creation
- # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
- # created corresponding to every Identity Source `identity_source_id`.
- "id": "A String", # The id of the entity within the given namespace. The id must be unique
- # within its namespace.
+ # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
},
- "createTime": "A String", # Creation timestamp of the Membership.
- "updateTime": "A String", # Last updated timestamp of the Membership.
- "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the
- # Membership in the format: `groups/{group_id}/memberships/{member_id}`,
- # where group_id is the unique id assigned to the Group to which Membership
- # belongs to, and member_id is the unique id assigned to the member
+ ],
+ "memberKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Immutable. The `EntityKey` of the member.
+ #
+ # Either `member_key` or `preferred_member_key` must be set when calling
+ # MembershipsService.CreateMembership but not both; both shall be set
+ # when returned.
+ #
+ # 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.
#
- # Must be left blank while creating a Membership.
- }</pre>
+ # 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`.
+ },
+ "preferredMemberKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the member.
+ #
+ # Either `member_key` or `preferred_member_key` must be set when calling
+ # MembershipsService.CreateMembership but not both; both shall be set
+ # when returned.
+ #
+ # 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 `Membership` was created.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, view=None)</code>
- <pre>List Memberships within a Group.
+ <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, view=None)</code>
+ <pre>Lists the `Membership`s within a `Group`.
Args:
- parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the
-Group to list Memberships within.
+ parent: string, Required. The parent `Group` resource under which to lookup the `Membership` name.
-Format: `groups/{group_id}`, where `group_id` is the unique id assigned to
-the Group. (required)
- pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50
-(max 500) for the FULL view.
- pageToken: string, The next_page_token value returned from a previous list request, if any
+Must be of the form `groups/{group_id}`. (required)
+ pageToken: string, The `next_page_token` value returned from a previous search request, if
+any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- view: string, Membership resource view to be returned. Defaults to MembershipView.BASIC.
+ pageSize: integer, The maximum number of results to return.
+
+Note that the number of results returned may be less than this value even
+if there are more available results. To fetch all results, clients must
+continue calling this method repeatedly until the response no longer
+contains a `next_page_token`.
+
+If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for
+`GroupView.FULL`.
+
+Must not be greater than 1000 for `GroupView.BASIC` or 500 for
+`GroupView.FULL`.
+ view: string, The level of detail to be returned.
+
+If unspecified, defaults to `MembershipView.BASIC`.
Returns:
An object of the form:
- {
- "memberships": [ # List of Memberships
- { # Resource representing a Membership within a Group
- "roles": [ # Roles for a member within the Group.
+ { # The response message for MembershipsService.ListMemberships.
+ "nextPageToken": "A String", # A continuation token to retrieve the next page of results, or empty if
+ # there are no more results available.
+ "memberships": [ # The `Membership`s under the specified `parent`.
+ { # A membership within the Cloud Identity Groups API.
+ #
+ # A `Membership` defines a relationship between a `Group` and an entity
+ # belonging to that `Group`, referred to as a "member".
+ "updateTime": "A String", # Output only. The time when the `Membership` was last updated.
+ "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
+ # the `Membership`.
+ #
+ # Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
+ "roles": [ # The `MembershipRole`s that apply to the `Membership`.
+ #
+ # If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`.
+ #
+ # Must not contain duplicate `MembershipRole`s with the same `name`.
+ { # A membership role within the Cloud Identity Groups API.
#
- # Currently supported MembershipRoles: `"MEMBER"`.
- { # Resource representing a role within a Membership.
- "name": "A String", # MembershipRole in string format.
- #
- # Currently supported MembershipRoles: `"MEMBER"`.
- },
- ],
- "memberKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # EntityKey of the entity to be added as the member. Must be set while
- # creating a Membership, read-only afterwards.
- #
- # Currently allowed entity types: `Users`, `Groups`.
- # isolation for ids. A single Id can be reused across namespaces but the
- # combination of a namespace and an id must be unique.
- "namespace": "A String", # Namespaces provide isolation for ids, i.e an id only needs to be unique
- # within its namespace.
+ # A `MembershipRole` defines the privileges granted to a `Membership`.
+ "name": "A String", # The name of the `MembershipRole`.
#
- # Namespaces are currently only created as part of IdentitySource creation
- # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
- # created corresponding to every Identity Source `identity_source_id`.
- "id": "A String", # The id of the entity within the given namespace. The id must be unique
- # within its namespace.
+ # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
},
- "createTime": "A String", # Creation timestamp of the Membership.
- "updateTime": "A String", # Last updated timestamp of the Membership.
- "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the
- # Membership in the format: `groups/{group_id}/memberships/{member_id}`,
- # where group_id is the unique id assigned to the Group to which Membership
- # belongs to, and member_id is the unique id assigned to the member
+ ],
+ "memberKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Immutable. The `EntityKey` of the member.
+ #
+ # Either `member_key` or `preferred_member_key` must be set when calling
+ # MembershipsService.CreateMembership but not both; both shall be set
+ # when returned.
+ #
+ # 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.
#
- # Must be left blank while creating a Membership.
+ # 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`.
},
+ "preferredMemberKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the member.
+ #
+ # Either `member_key` or `preferred_member_key` must be set when calling
+ # MembershipsService.CreateMembership but not both; both shall be set
+ # when returned.
+ #
+ # 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 `Membership` was created.
+ },
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results available for listing.
}</pre>
</div>
@@ -391,24 +533,31 @@
<div class="method">
<code class="details" id="lookup">lookup(parent, memberKey_namespace=None, memberKey_id=None, x__xgafv=None)</code>
- <pre>Looks up [resource
-name](https://cloud.google.com/apis/design/resource_names) of a Membership
-within a Group by member's EntityKey.
+ <pre>Looks up the [resource
+name](https://cloud.google.com/apis/design/resource_names) of a
+`Membership` by its `EntityKey`.
Args:
- parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the
-Group to lookup Membership within.
+ parent: string, Required. The parent `Group` resource under which to lookup the `Membership` name.
-Format: `groups/{group_id}`, where `group_id` is the unique id assigned to
-the Group. (required)
- memberKey_namespace: string, Namespaces provide isolation for ids, i.e an id only needs to be unique
-within its namespace.
+Must be of the form `groups/{group_id}`. (required)
+ memberKey_namespace: string, The namespace in which the entity exists.
-Namespaces are currently only created as part of IdentitySource creation
-from Admin Console. A namespace `"identitysources/{identity_source_id}"` is
-created corresponding to every Identity Source `identity_source_id`.
- memberKey_id: string, The id of the entity within the given namespace. The id must be unique
-within its namespace.
+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}.
+ memberKey_id: 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`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -417,13 +566,165 @@
Returns:
An object of the form:
- {
- "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the
- # Membership being looked up.
+ { # The response message for MembershipsService.LookupMembershipName.
+ "name": "A String", # The [resource name](https://cloud.google.com/apis/design/resource_names) of
+ # the looked-up `Membership`.
#
- # Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is
- # the unique id assigned to the Group to which Membership belongs to, and
- # `member_id` is the unique id assigned to the member.
+ # Must be of the form `groups/{group_id}/memberships/{membership_id}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="modifyMembershipRoles">modifyMembershipRoles(name, body=None, x__xgafv=None)</code>
+ <pre>Modifies the `MembershipRole`s of a `Membership`.
+
+Args:
+ name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of
+the `Membership` whose roles are to be modified.
+
+Must be of the form `groups/{group_id}/memberships/{membership_id}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for MembershipsService.ModifyMembershipRoles.
+ "removeRoles": [ # The `name`s of the `MembershipRole`s to be removed.
+ #
+ # Adding or removing roles in the same request as updating roles is not
+ # supported.
+ #
+ # It is not possible to remove the `MEMBER` `MembershipRole`. If you wish to
+ # delete a `Membership`, call MembershipsService.DeleteMembership
+ # instead.
+ #
+ # Must not contain `MEMBER`. Must not be set if `update_roles_params` is set.
+ "A String",
+ ],
+ "updateRolesParams": [ # The `MembershipRole`s to be updated.
+ #
+ # Updating roles in the same request as adding or removing roles is not
+ # supported.
+ #
+ # Must not be set if either `add_roles` or `remove_roles` is set.
+ { # The details of an update to a `MembershipRole`.
+ "fieldMask": "A String", # The fully-qualified names of fields to update.
+ #
+ # May only contain the field `expiry_detail`.
+ "membershipRole": { # A membership role within the Cloud Identity Groups API. # The `MembershipRole`s to be updated.
+ #
+ # Only `MEMBER` `MembershipRoles` can currently be updated.
+ #
+ # May only contain a `MembershipRole` with `name` `MEMBER`.
+ #
+ # A `MembershipRole` defines the privileges granted to a `Membership`.
+ "name": "A String", # The name of the `MembershipRole`.
+ #
+ # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
+ },
+ },
+ ],
+ "addRoles": [ # The `MembershipRole`s to be added.
+ #
+ # Adding or removing roles in the same request as updating roles is not
+ # supported.
+ #
+ # Must not be set if `update_roles_params` is set.
+ { # A membership role within the Cloud Identity Groups API.
+ #
+ # A `MembershipRole` defines the privileges granted to a `Membership`.
+ "name": "A String", # The name of the `MembershipRole`.
+ #
+ # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
+ },
+ ],
+ }
+
+ 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 MembershipsService.ModifyMembershipRoles.
+ "membership": { # A membership within the Cloud Identity Groups API. # The `Membership` resource after modifying its `MembershipRole`s.
+ #
+ # A `Membership` defines a relationship between a `Group` and an entity
+ # belonging to that `Group`, referred to as a "member".
+ "updateTime": "A String", # Output only. The time when the `Membership` was last updated.
+ "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
+ # the `Membership`.
+ #
+ # Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
+ "roles": [ # The `MembershipRole`s that apply to the `Membership`.
+ #
+ # If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`.
+ #
+ # Must not contain duplicate `MembershipRole`s with the same `name`.
+ { # A membership role within the Cloud Identity Groups API.
+ #
+ # A `MembershipRole` defines the privileges granted to a `Membership`.
+ "name": "A String", # The name of the `MembershipRole`.
+ #
+ # Must be one of `OWNER`, `MANAGER`, `MEMBER`.
+ },
+ ],
+ "memberKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Immutable. The `EntityKey` of the member.
+ #
+ # Either `member_key` or `preferred_member_key` must be set when calling
+ # MembershipsService.CreateMembership but not both; both shall be set
+ # when returned.
+ #
+ # 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`.
+ },
+ "preferredMemberKey": { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the member.
+ #
+ # Either `member_key` or `preferred_member_key` must be set when calling
+ # MembershipsService.CreateMembership but not both; both shall be set
+ # when returned.
+ #
+ # 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 `Membership` was created.
+ },
}</pre>
</div>