Sign in
Groups (Preferred)

Add users to a group

Adds one or more users to the specified group. Pass a single-element array to add one user.

Users that are already members of 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}/add-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 added 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.