Skip to main content
POST
Suspend the user flagged by a Praxis Shield incident

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

incidentId
string
required

Incident id (drives the target user and the institution scope)

Body

application/json
scope
enum<string>

Suspend axis. institution (default) inactivates only the memberships for the incident institutions the caller manages. global (super-only) deactivates the account + revokes keys/sessions.

Available options:
institution,
global

Response

Suspend applied

success
boolean
scope
enum<string>
Available options:
global,
institution
suspendedMemberships
integer
userDeactivated
boolean
tokensRevoked
boolean