Skip to main content
Version: 2.12

authorization

Hot Reloadable

Static single or multi-user declaration.

Properties

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

* See the property page for reload caveats.