Users

Replace User

put/api/users/{username}

Path parameters

usernamestring required

Request body

usernamestring required

Username of the user.

scope'admin' | 'install' | 'update' | 'read'
totp_enabledboolean

Whether two-factor authentication is enabled/required using TOTP. Not available if Passkey is used.

passkeyboolean

Whether this user authenticates using a Passkey.

passwordstring password required

Password of the user.

Response

User replaced

usernamestring

Username of the user.

scope'admin' | 'install' | 'update' | 'read'
totp_enabledboolean

Whether two-factor authentication is enabled/required using TOTP. Not available if Passkey is used.

passkeyboolean

Whether this user authenticates using a Passkey.

Changes