| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <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=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="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves a `Membership`.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, view=None, pageToken=None, pageSize=None, x__xgafv=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 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=None, x__xgafv=None)</code> |
| <pre>Creates a `Membership`. |
| |
| Args: |
| 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: |
| |
| { # 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". |
| "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. |
| "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`. |
| "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}. |
| }, |
| "createTime": "A String", # Output only. The time when the `Membership` was created. |
| "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}`. |
| "type": "A String", # Output only. The type of the 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. |
| "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`. |
| "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}. |
| }, |
| "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`. |
| "expiryDetail": { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. |
| # |
| # Expiry details are only supported for `MEMBER` `MembershipRoles`. |
| # |
| # May be set if `name` is `MEMBER`. Must not be set if `name` is any other |
| # value. |
| "expireTime": "A String", # The time at which the `MembershipRole` will expire. |
| }, |
| "name": "A String", # The name of the `MembershipRole`. |
| # |
| # Must be one of `OWNER`, `MANAGER`, `MEMBER`. |
| }, |
| ], |
| "updateTime": "A String", # Output only. The time when the `Membership` was last updated. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "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 |
| # 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). |
| "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 |
| # message types for APIs to use. |
| { |
| "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. |
| }, |
| "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 |
| # 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. |
| }, |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes a `Membership`. |
| |
| Args: |
| name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of |
| the `Membership` to delete. |
| |
| Must be of the form `groups/{group_id}/memberships/{membership_id}`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "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 |
| # 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). |
| "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 |
| # message types for APIs to use. |
| { |
| "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. |
| }, |
| "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 |
| # 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. |
| }, |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Retrieves a `Membership`. |
| |
| Args: |
| name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of |
| the `Membership` to retrieve. |
| |
| Must be of the form `groups/{group_id}/memberships/{membership_id}`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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". |
| "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. |
| "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`. |
| "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}. |
| }, |
| "createTime": "A String", # Output only. The time when the `Membership` was created. |
| "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}`. |
| "type": "A String", # Output only. The type of the 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. |
| "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`. |
| "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}. |
| }, |
| "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`. |
| "expiryDetail": { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. |
| # |
| # Expiry details are only supported for `MEMBER` `MembershipRoles`. |
| # |
| # May be set if `name` is `MEMBER`. Must not be set if `name` is any other |
| # value. |
| "expireTime": "A String", # The time at which the `MembershipRole` will expire. |
| }, |
| "name": "A String", # The name of the `MembershipRole`. |
| # |
| # Must be one of `OWNER`, `MANAGER`, `MEMBER`. |
| }, |
| ], |
| "updateTime": "A String", # Output only. The time when the `Membership` was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, view=None, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| <pre>Lists the `Membership`s within a `Group`. |
| |
| Args: |
| parent: string, Required. The parent `Group` resource under which to lookup the `Membership` name. |
| |
| Must be of the form `groups/{group_id}`. (required) |
| view: string, The level of detail to be returned. |
| |
| If unspecified, defaults to `MembershipView.BASIC`. |
| pageToken: string, The `next_page_token` value returned from a previous search request, if |
| any. |
| 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`. |
| 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.ListMemberships. |
| "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". |
| "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. |
| "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`. |
| "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}. |
| }, |
| "createTime": "A String", # Output only. The time when the `Membership` was created. |
| "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}`. |
| "type": "A String", # Output only. The type of the 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. |
| "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`. |
| "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}. |
| }, |
| "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`. |
| "expiryDetail": { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. |
| # |
| # Expiry details are only supported for `MEMBER` `MembershipRoles`. |
| # |
| # May be set if `name` is `MEMBER`. Must not be set if `name` is any other |
| # value. |
| "expireTime": "A String", # The time at which the `MembershipRole` will expire. |
| }, |
| "name": "A String", # The name of the `MembershipRole`. |
| # |
| # Must be one of `OWNER`, `MANAGER`, `MEMBER`. |
| }, |
| ], |
| "updateTime": "A String", # Output only. The time when the `Membership` was last updated. |
| }, |
| ], |
| "nextPageToken": "A String", # A continuation token to retrieve the next page of results, or empty if |
| # there are no more results available. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| 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 |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="lookup">lookup(parent, memberKey_namespace=None, memberKey_id=None, x__xgafv=None)</code> |
| <pre>Looks up the [resource |
| name](https://cloud.google.com/apis/design/resource_names) of a |
| `Membership` by its `EntityKey`. |
| |
| Args: |
| parent: string, Required. The parent `Group` resource under which to lookup the `Membership` name. |
| |
| Must be of the form `groups/{group_id}`. (required) |
| memberKey_namespace: 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}. |
| 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 |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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`. |
| # |
| # 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. |
| "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`. |
| "expiryDetail": { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. |
| # |
| # Expiry details are only supported for `MEMBER` `MembershipRoles`. |
| # |
| # May be set if `name` is `MEMBER`. Must not be set if `name` is any other |
| # value. |
| "expireTime": "A String", # The time at which the `MembershipRole` will expire. |
| }, |
| "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`. |
| "expiryDetail": { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. |
| # |
| # Expiry details are only supported for `MEMBER` `MembershipRoles`. |
| # |
| # May be set if `name` is `MEMBER`. Must not be set if `name` is any other |
| # value. |
| "expireTime": "A String", # The time at which the `MembershipRole` will expire. |
| }, |
| "name": "A String", # The name of the `MembershipRole`. |
| # |
| # Must be one of `OWNER`, `MANAGER`, `MEMBER`. |
| }, |
| ], |
| "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", |
| ], |
| } |
| |
| 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". |
| "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. |
| "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`. |
| "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}. |
| }, |
| "createTime": "A String", # Output only. The time when the `Membership` was created. |
| "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}`. |
| "type": "A String", # Output only. The type of the 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. |
| "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`. |
| "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}. |
| }, |
| "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`. |
| "expiryDetail": { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. |
| # |
| # Expiry details are only supported for `MEMBER` `MembershipRoles`. |
| # |
| # May be set if `name` is `MEMBER`. Must not be set if `name` is any other |
| # value. |
| "expireTime": "A String", # The time at which the `MembershipRole` will expire. |
| }, |
| "name": "A String", # The name of the `MembershipRole`. |
| # |
| # Must be one of `OWNER`, `MANAGER`, `MEMBER`. |
| }, |
| ], |
| "updateTime": "A String", # Output only. The time when the `Membership` was last updated. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
