whitelist_add

Add a user to the whitelist. A whitelisted user is let in whatever the access mode, without a password or invite.

Request

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

Field	Type	Required	Description
`user`	string	Yes	A user ID or username. Leading and trailing spaces and a leading `@` are ignored. Usernames match without regard to case.

The server must already have a record of the user, which means they have authenticated on this server before. To admit someone new, approve an application or give them an invite.

Response

{
  "cmd": "whitelist_add",
  "user": "USR:local_alice",
  "user_id": "USR:local_alice",
  "added": true
}

user is the user’s username and user_id is the ID stored in the whitelist. For server accounts the two are the same; for Rotur accounts the ID is the Rotur account ID. The change is recorded in the audit log. Nobody else is notified.

Permissions

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

Errors

`val`	When
`User '<user>' not found`	No known user has that ID or username.
`User '<user>' is already whitelisted`	The user is already on the whitelist.

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

See also