Sign in
Groups

Update a user's membership type in a group

Allows a group owner or an authorized user to change the role of a user within a group to OWNER or MEMBER.

put/api/v1/{tenant}/groups/{id}/members/membership/{userId}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/groups/{id}/members/membership/{userId}
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

idstring required

The ID of the group

userIdstring required

The ID of the user whose membership is being updated

tenantstring required

Query parameters

membership'OWNER' | 'MEMBER' required

The new membership type to assign to the user.

Response

Membership type successfully updated

idstring
usernamestring
displayNamestring

Example response

{
  "displayName": "displayName",
  "groups": [
    {
      "external": true,
      "name": "name",
      "id": "id",
      "membership": "OWNER"
    },
    {
      "external": true,
      "name": "name",
      "id": "id",
      "membership": "OWNER"
    }
  ],
  "id": "id",
  "username": "username"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.