Removing Users from User Groups

Prerequisites

  • Permission: data:user_group:delete for the target group

  • User must be a member of the group

API Endpoint

DELETE /groups/members?identifier={group_identifier}&user_identifier={user_identifier}

Query Parameters

  • identifier (required): Group UUID

  • user_identifier (required): User UUID to remove

Response

{
  "ok": true
}

Example:

curl -X DELETE "https://api.example.com/groups/members?identifier=550e8400-e29b-41d4-a716-446655440000&user_identifier=123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_TOKEN"

Self-Service: Users Leaving Groups

Users can leave groups themselves:

Endpoint:

DELETE /principal/user/groups?identifier={group_identifier}

Notes

  • Removing a user immediately revokes roles inherited from that group

  • The user retains roles from other groups

  • Removing a user from a group does not delete the user account

Last updated