users_banned_list.md

Command: users_banned_list

List all banned users on the server. Requires manage_users permission.

Request

{
  "cmd": "users_banned_list"
}

Fields

None.

Response

On Success

{
  "cmd": "users_banned_list",
  "users": ["username1", "username2", "username3"]
}

Error Responses

• {"cmd": "error", "val": "Authentication required"}
• {"cmd": "error", "val": "Access denied: manage_users permission required"}

Permissions

• Requires manage_users permission.

Notes

• Banned users list can only be viewed by users with the manage_users permission.
• Returns a list of usernames (not user IDs).
• Banned users are those with the banned role.
• Banned users cannot authenticate with the server.
• Currently connected banned users will remain connected until they disconnect.
• Empty list is returned if no users are banned.
• Use user_unban to remove a user from the banned list.
• Use user_ban to add a user to the banned list.

See Also

• user_ban - Ban a user
• user_unban - Unban a user
• users_list - List all users

See implementation: handlers/message.py (search for case "users_banned_list":).