Method: groups.memberships.modifyMembershipRoles

Modifies the MembershipRole s of a Membership .

HTTP request

POST https://cloudidentity.googleapis.com/v1/{name=groups/*/memberships/*}:modifyMembershipRoles

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`name`	`string` Required. The resource name of the `Membership` whose roles are to be modified. Must be of the form `groups/{group}/memberships/{membership}` .

name

string

Required. The resource name of the Membership whose roles are to be modified.

Must be of the form groups/{group}/memberships/{membership} .

Request body

The request body contains data with the following structure:

JSON representation
{ "addRoles" : [ { object ( `MembershipRole` ) } ] , "removeRoles" : [ string ] , "updateRolesParams" : [ { object ( `UpdateMembershipRolesParams` ) } ] }

Fields

Fields
`addRoles[]`	`object ( MembershipRole )` 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.
`removeRoles[]`	`string` 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.
`updateRolesParams[]`	`object ( UpdateMembershipRolesParams )` 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.

addRoles[]

object ( MembershipRole )

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.

removeRoles[]

string

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.

updateRolesParams[]

object ( UpdateMembershipRolesParams )

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.

Response body

The response message for MembershipsService.ModifyMembershipRoles .

If successful, the response body contains data with the following structure:

JSON representation
{ "membership" : { object ( `Membership` ) } }

Fields

Fields
`membership`	`object ( Membership )` The `Membership` resource after modifying its `MembershipRole` s.

membership

object ( Membership )

The Membership resource after modifying its MembershipRole s.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/cloud-identity.groups
https://www.googleapis.com/auth/cloud-identity
https://www.googleapis.com/auth/cloud-platform

For more information, see the Authorization guide .

UpdateMembershipRolesParams

The details of an update to a MembershipRole .

JSON representation
{ "fieldMask" : string , "membershipRole" : { object ( `MembershipRole` ) } }

Fields

Fields
`fieldMask`	`string ( FieldMask format)` The fully-qualified names of fields to update. May only contain the field `expiry_detail.expire_time` . This is a comma-separated list of fully qualified names of fields. Example: `"user.displayName,photo"` .
`membershipRole`	`object ( MembershipRole )` The `MembershipRole` s to be updated. Only `MEMBER` `MembershipRole` can currently be updated.

fieldMask

string ( FieldMask format)

The fully-qualified names of fields to update.

May only contain the field expiry_detail.expire_time .

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo" .

membershipRole

object ( MembershipRole )

The MembershipRole s to be updated.

Only MEMBER MembershipRole can currently be updated.