whitelist_remove

Remove a user from the whitelist. This doesn’t disconnect them or end their membership.

Request

{ "cmd": "whitelist_remove", "user": "USR:local_alice" }

Field	Type	Required	Description
`user`	string	Yes	A whitelisted user ID, or the username of a whitelisted user. Usernames match without regard to case. The server also matches the username on the user’s join application, so users it has no other record of can still be removed.

{
  "cmd": "whitelist_remove",
  "user": "USR:local_alice",
  "user_id": "USR:local_alice",
  "removed": true
}

user_id is the ID removed from the whitelist and user is that user’s username. The change is recorded in the audit log. Nobody else is notified.

What removal means for the user’s next login depends on the mode:

In whitelist and application modes, a user who is still a member keeps getting in. Kicking doesn’t end membership either; use user_ban to keep them out.
In password and invite modes, they need the server password or a new invite.

Requires manage_access. A user in timeout gets a rate_limit frame instead.

`val`	When
`User '<user>' is not in the whitelist`	No whitelist entry matches `user`, or the server couldn’t save the change.

A missing or empty user returns the schema validator’s message.