Reference

authorization

Static single or multi-user declaration.

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

Values

TypeDescriptionChoices
objectAn object with a set of explicit properties that can be set.-

Properties

NameDescriptionTypeDefault
usernameSpecifies a global user name that clients can use to authenticate the server (requires password, exclusive of token).string-
passwordSpecifies a global password that clients can use to authenticate the server (requires user, exclusive of token).string-
tokenSpecifies a global token that clients can use to authenticate with the server (exclusive of user and password).string-
usersA list of multiple users with different credentials.object-
default_permissionsThe default permissions applied to users, if permissions are not explicitly defined for them.object-
timeoutMaximum number of seconds to wait for a client to authenticate.float1
auth_calloutEnables the auth callout functionality. All client connections requiring authentication will have their credentials pass-through to a dedicated auth service.object-
Previous
no_auth_user