POST/api/admin/users/{uid}/disableAdmin

Disable a user

Marks the account disabled and revokes every session and token it holds (the user's tokens_valid_after watermark is pinned while the account stays disabled), so it can no longer log in or use an existing session. Administrators cannot disable themselves.

operationId post_api_admin_users_uid_disableAdministration

Authentication & permissionsAdmin

Platform administrators only

Accepted credentials: Auth server session (refresh token cookie)cookie "refresh_token_<auth_server_app_id>"
Access token (cookie)cookie "access_token_<auth_server_app_id>"
Access token (Bearer)Authorization: Bearer <JWT>
Who may call: Platform administrators only

Path parameters

Name	Type	Description
uid*	string (uuid)	uid of the target user

Responses

application/json

ResourceCreationResponse

Property	Type	Description
success*	true
message*	string
resource_id*	string	Identifier of the created / affected resource

JSONExample

"success"true

"message""string"

"resource_id""string"

Example request

bashcurl

curl -X POST 'https://auth.schemavaults.com/api/admin/users/<uid>/disable' \
  -b 'refresh_token_<auth_server_app_id>=<value>'

Other methods on this path

DELETERe-enable a user

Authentication & permissionsAdmin

Path parameters

Responses

200The user's disabled state was updated

400The request failed validation (issues lists the offending fields) or was refused by the handler

401No valid session cookie, access token cookie or bearer access token was presented, or the token was revoked

403The caller is not a platform administrator

404No such user

500Failed to update the user

Example request

Other methods on this path