Revoke user access

post/v1/viewer/users/revoke-access

Deactivates a user's access to the system. The user will no longer be able to log in or access resources. User data is preserved and can be reactivated later.

Body ParametersExpand Collapse

userId: string

User ID to revoke access for. Format: usr_{32-hex-chars}

ReturnsExpand Collapse

success: boolean

message: optional string

Revoke user access

curl https://api.avarasoftware.com/v1/viewer/users/revoke-access \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $AVARA_API_KEY" \
    -d '{
          "userId": "usr_1234567890abcdef1234567890abcdef"
        }'

{
  "success": true,
  "message": "User access revoked successfully"
}

Returns Examples

{
  "success": true,
  "message": "User access revoked successfully"
}