Skip to content

user_unban

Remove a user’s ban so they can sign in again.

{
"cmd": "user_unban",
"user": "alice"
}
Field Type Required Description
user string Yes Username or user ID. Matching ignores letter case and a leading @.
{
"cmd": "user_unban",
"user": "alice",
"unbanned": true
}

unbanned is true only when this request changed something:

  • If the user wasn’t banned, you get their username and unbanned: false.
  • If no account matches, you get user: null and unbanned: false. This is not an error.

An unban removes the banned role and records an entry in the audit log. Nothing is broadcast.

Requires manage_users. It is blocked while you are timed out.

val When
Unable to save users The server could not write the change to storage.
Validation message user is missing, not a string, or blank.