PUT/root/identities/{userId}/suspension
Suspend an identity
Operation root.identities.suspension.put
Description
Suspends an identity: its sign-in is refused and every live session is revoked. Only root operators may call it; suspending another root operator returns 409, and every attempt is recorded in the root audit trail. A failed session sweep returns 500 and can be repeated.
Authentication
Requires a signed-in session: the client sends its session token as a bearer token in the Authorization header.
Parameters
| Name | In | Type | Details |
|---|---|---|---|
userId | path | string | required
|
Responses
200 OK
application/jsonRootIdentitySuspensionResponse
The identity after a suspension was placed or lifted.
1 field
Other fields are allowed.
Other responses
| Status | Meaning | Body |
|---|---|---|
| 400 | Bad Request |
|
| 401 | Unauthorized |
|
| 403 | Forbidden |
|
| 404 | Not Found |
|
| 409 | Conflict |
|
| 500 | Internal Server Error |
|
| 503 | Service Unavailable |
|