Method: groups.memberships.modifyMembershipRoles

Modifies the MembershipRoles of a Membership.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

Must be of the form groups/{group_id}/memberships/{membership_id}.

Request body

The request body contains data with the following structure:

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

object (MembershipRole)

The MembershipRoles to be added.

Adding or removing roles in the same request as updating roles is not supported.

Must not be set if updateRolesParams is set.

removeRoles[]

string

The names of the MembershipRoles 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 updateRolesParams is set.

Response body

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

The response message for MembershipsService.ModifyMembershipRoles.

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

object (Membership)

The Membership resource after modifying its MembershipRoles.

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 Authentication Overview.