Class: JWTStrategyOptions
Defined in: service-core/src/auth/JWTStrategy.ts:19
Describes the configuration options that can be used to initialize JWTStrategy.
Constructors
Constructor
new JWTStrategyOptions():
JWTStrategyOptions
Returns
JWTStrategyOptions
Properties
allowQueryParam
allowQueryParam:
boolean=false
Defined in: service-core/src/auth/JWTStrategy.ts:37
Set to true to allow tokens to be supplied via the queryKey URL parameter.
Disabled by default — query parameters appear in server logs, browser history, and
Referer headers, which permanently exposes tokens outside the application.
config?
optionalconfig?:JWTUtilsConfig
Defined in: service-core/src/auth/JWTStrategy.ts:21
The configuration options to pass to the JWTUtils library during token verification.
cookieName
cookieName:
string="jwt"
Defined in: service-core/src/auth/JWTStrategy.ts:27
The name of the cookie to retrieve the token from when using cookie based authentication. Default value is jwt.
cookieSecure
cookieSecure:
boolean=false
Defined in: service-core/src/auth/JWTStrategy.ts:29
The name of the secured cookie to retreive the token from when using cookie based authentication.
headerKey
headerKey:
string="authorization"
Defined in: service-core/src/auth/JWTStrategy.ts:23
The name of the header to look for when performing header based authentication. Default value is Authorization.
headerScheme
headerScheme:
string= "(jwt|bearer)"
Defined in: service-core/src/auth/JWTStrategy.ts:25
The authorization scheme type when using header based authentication. Default value is jwt.
queryKey
queryKey:
string="auth_token"
Defined in: service-core/src/auth/JWTStrategy.ts:31
The name of the request query parameter to retrieve the token from when using query based authentication. Default value is auth_token.