v7

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01426118.4 KB

Admin Utils

Convict user

Mark a user as convicted/banned by setting their trust level. Requires admin write permissions and authority to change the target user trust level.

post/api/admin/v1/user/convict

Request body

user_idinteger required

Target user ID. id is also accepted as an alias.

reasonstring required

Required justification; a blank reason returns 422.

trust_level'blue' | 'red' | 'green' | 'yellow' required

Required. New trust level; must be a valid trust level key or a 422 is returned.

notesstring

Optional notes stored on the audit log.

Example request

{
  "user_id": 42,
  "reason": "self-reported heartbeats",
  "trust_level": "red",
  "notes": "Reviewed flagged activity"
}

Response

successful

successboolean

messagestring

Example response

{
  "success": true,
  "message": "User convicted successfully",
  "user": {
    "id": 42,
    "username": "orpheus",
    "trust_level": "red",
    "updated_at": "2024-03-20T15:30:00Z"
  },
  "audit_log": {
    "changed_by": "orpheus",
    "reason": "self-reported heartbeats",
    "notes": "Reviewed flagged activity",
    "timestamp": "2024-03-20T15:30:00Z"
  }
}