Groups

Update user group

Updates an existing user group by adding or removing users and roles. Allows dynamic management of group membership and permissions to maintain proper access control. Requires enterprise features to be enabled.

put/api/{org_id}/groups/{group_name}

Request

Path parameters

org_idstring required

Organization name

group_namestring required

Group name

Request body

add_rolesstring[] nullable
add_usersstring[] nullable
remove_rolesstring[] nullable
remove_usersstring[] nullable

Response

Success

codeinteger required
error_detailstring nullable
hintstring nullable

One-line guidance on how to fix the error (agent self-correction, D4).

idstring nullable
messagestring required
namestring nullable
suggestionsstring[] nullable

Closest valid alternatives for a mistyped field/function name.

trace_idstring nullable
warningsstring[] nullable

Problems with a request that succeeded anyway. Distinct from hint, which explains a failure: these accompany a 200, and the caller is entitled to have meant it.

Changes

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