User groups

Prev Next
Description Delete a user group. The platform applies a soft delete, so the record is deactivated rather than erased, and all memberships of the group are removed with it. Membership alone never blocks the deletion. The deletion is refused while...
Description Retrieve the full detail of a single user group by its identification code. The response carries the group attributes, the actions available in its current state, and a strong entity tag in the ETag header. Send this request before...
Description List the user groups registered on the platform. The response is paginated and supports global search, sorting, field projection, and filters by name, active state, and external identifier. Filtering by external identifier is what le...
List the access policies bound to a user group. The response is paginated, and each row reports the bound policy, the profile the binding grants, its approval level, and who created it.
Description List the active members of a user group. The response is paginated, and each row reports how the membership was created, who added it, and when. The creation_type field is what separates a membership managed by an integration from ...
Description Change selected attributes of a user group. The request body follows the JSON Merge Patch format and lists only the fields to change, so every field left out keeps its current value. The request requires the If-Match header, which ...
Description Activate an inactive user group. Activation is a dedicated action rather than a field, so the active state cannot be changed through PUT | Update user group or PATCH | Partially update user group . An update sent to an inactive ...
Bind one or more access policies to a user group. Each binding carries the access policy, the profile it grants to the members of the group, and its approval level.
Description Add one or more users to a user group. A user who is already an active member is ignored, and a membership that exists but is inactive is reactivated, so the same request can be repeated safely. Prerequisites An application wit...
Description Create a user group on the platform. The request defines the group name and an optional description. The group is created in the active state, with no members and no access policy bindings. Prerequisites An application with the...
Description Deactivate a user group. All memberships of the group are removed with it, and the group stays registered on the platform as inactive. While the group is inactive, PUT | Update user group , PATCH | Partially update user group , and m...
Description Replace the editable attributes of a user group. The request body carries the complete set of editable fields, so any optional field omitted from the body is cleared. The request requires the If-Match header, which protects the gro...
Remove one or more access policy bindings from a user group. The bindings are deactivated rather than erased.
Description Remove one or more users from a user group. The memberships are deactivated rather than erased, and a user who is not currently a member is ignored, so the same request can be repeated safely. Prerequisites An application with ...