Reference

users

A list of multiple users with different credentials.

  • Default value: n/a
  • Hot reloadable: Yes

Values

TypeDescriptionChoices
[ object ]An object with a set of explicit properties that can be set.-

Properties

NameDescriptionTypeDefault
usernameName of the user.string-
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-
nkeyPublic NKey identifying the user. The value begins with a U character. Exclusive with username and password.string-
permissionsobject-
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-
Previous
token