Skip to main content
Version: 2.12

users

Hot Reloadable

A list of multiple users with different credentials.

Properties

NameDescriptionTypeDefaultReloadable
usernameName of the user.string-Yes
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-Yes
nkeyPublic NKey identifying the user. The value begins with a U character. Exclusive with username and password.string-Yes
permissionsobject-Yes
allowed_connection_typesIf specified, the user is constrained to the specified connection types. - STANDARD indicates a standard client TCP connection using the NATS protocol. - WEBSOCKET indicates a WebSocket-based connection to NATS if the websockets configuration is enabled. - LEAFNODE indicates a connection established by configured leafnode remote on a server. - MQTT indicates a connection established by an MQTT client to NATS if the mqtt configuration is enabled.string-Yes