Sign in
admin-groups

Update Group

Update a security group.

If is_active changes, invalidates all permission caches since group membership affects permission set resolution.

put/api/v1/admin/groups/{group_id}

Path parameters

group_idinteger required

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

namestring nullable
descriptionstring nullable
is_activeboolean nullable

Response

Successful Response

idinteger required
namestring required
descriptionstring nullable
is_activeboolean
member_countinteger nullable
created_atstring date-time nullable
updated_atstring date-time nullable

Changes

No recorded changes to this endpoint across all 5 revisions of this API.