Sign in
Groups (Preferred)

Remove users from a group

Removes one or more users from the specified group. Pass a single-element array to remove one user.

Users not currently in the group are silently ignored (the operation is idempotent). An empty user_ids array is accepted and is a no-op.

Requires the GROUPMANAGEMENT security role.

post/api/1/groups/{groupId}/remove-users

Path parameters

groupIdstring uuid required

ID of the group (hyphens optional).

Request body

user_idsstring[] required

IDs of the users to add or remove. An empty list is a no-op.

Response

Users removed successfully.

user_countinteger

Updated number of members in the group after the operation.

Changes

No recorded changes to this endpoint across all 1 revision of this API.