API ReferenceAdmin Groups
Suspend Group
POST
/v1/admin/groups/{group_id}/suspendSuspend a group.
Its members lose what the group grants, at once: sign-in to the
applications it is attached to (unless another group still grants them),
the roles it confers, and self sign-up on every application that uses it as
its sign-up group. Their refresh tokens for those applications are revoked,
and applications that registered a back-channel logout URI with the
access-revoked initiator are told. Members keep their identity, devices
and passkeys, and the group keeps its members, applications and roles.
Suspending a suspended group changes nothing. Allowed on a group provisioned
by SCIM. Returns 404 for an unknown group.
Authorization
HTTPBearer AuthorizationBearer <token>
In: header
Path Parameters
group_id*Group Id
Format
uuidResponse Body
application/json
application/json
curl -X POST "https://example.com/v1/admin/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/suspend"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "scim_managed": false, "member_count": 0, "app_count": 0, "is_signup_group": false, "suspended_at": "2019-08-24T14:15:22Z"}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string", "input": null, "ctx": {} } ]}