Skip to main content
Version: 2.12

users

Requires Restart
Reordering the users array is accepted because the comparison is keyed by username.

A list of multiple users with different credentials.

Properties

NameDescriptionTypeDefaultReloadable
usernameName of the user.string-No
passwordPassword of the user. This can be a free-text value (not recommended) or a bcrypted value using the nats server passwd CLI command.string-No
accountAccount that leaf nodes authenticating as this user are bound to. Each user in the list can name a different account. The account must be declared in the accounts block or the server refuses to start. Leave it unset to bind to the global account; the account on the surrounding authorization block does not apply to users listed here.string-No
proxy_requiredReject this user's leaf node connections if they did not arrive through a PROXY protocol header. Setting proxy_required on the surrounding authorization block applies the requirement to every user regardless of what they set here.booleanfalseYes*

* See the property page for reload caveats.