BasicAuthConfig
Defined in: packages/gateway/src/policies/auth/basic-auth.ts:13
Configuration for the basicAuth policy.
Extends
Section titled “Extends”Properties
Section titled “Properties”realm?
Section titled “realm?”
optionalrealm?:string
Defined in: packages/gateway/src/policies/auth/basic-auth.ts:21
Realm for the WWW-Authenticate header. Default: “Restricted”
optionalskip?: (c) =>boolean|Promise<boolean>
Defined in: packages/gateway/src/policies/types.ts:90
Skip this policy when condition returns true
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”boolean | Promise<boolean>
Inherited from
Section titled “Inherited from”validate
Section titled “validate”validate: (
username,password,c) =>boolean|Promise<boolean>
Defined in: packages/gateway/src/policies/auth/basic-auth.ts:15
Validate username/password. Return true if valid.
Parameters
Section titled “Parameters”username
Section titled “username”string
password
Section titled “password”string
Context
Returns
Section titled “Returns”boolean | Promise<boolean>