user_update

Change a member’s nickname or stored username on this server. Moderators use it to fix display names. It doesn’t touch the user’s Rotur account.

Request

{
  "cmd": "user_update",
  "user": "alice",
  "updates": {
    "nickname": "Alice W."
  }
}

Field	Type	Required	Description
user	string	Yes	Username or user ID of the member to change. Matching ignores letter case and a leading @.
updates	object	Yes	The changes. Must contain username, nickname, or both, and no other keys.
updates.username	string	No	New username. At least 1 character, and not already used by another account.
updates.nickname	string or null	No	New display name. null removes the nickname.

Caution

Prefer nickname for display names. The username is the account’s sign-in identity. A Rotur account’s username is reset to its Rotur name the next time it signs in. A renamed local account can no longer sign in with its password, because password login checks the stored username.

Response

{
  "cmd": "user_update",
  "user": "alice",
  "nickname": "Alice W."
}

user is the username after the change. nickname is "" when the user has none. Every other authenticated connection receives the same frame. The change is recorded in the audit log.

Permissions

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

Errors

val	When
User not found	No account matches user.
Username already taken	Another account already has the new username.
Unable to save users	The server could not write the change to storage.
Validation message	user is missing or blank, updates is empty, has an unknown key, or a value has the wrong type.

See also

• User schema
• users_list