JwtAuthConfig
Defined in: src/policies/auth/jwt-auth.ts:19
Configuration for the jwtAuth policy.
Extends
Section titled “Extends”Properties
Section titled “Properties”audience?
Section titled “audience?”
optionalaudience:string
Defined in: src/policies/auth/jwt-auth.ts:27
Expected JWT audience
clockSkewSeconds?
Section titled “clockSkewSeconds?”
optionalclockSkewSeconds:number
Defined in: src/policies/auth/jwt-auth.ts:39
Clock skew tolerance in seconds for expiry checks. Default: 0.
forwardClaims?
Section titled “forwardClaims?”
optionalforwardClaims:Record<string,string>
Defined in: src/policies/auth/jwt-auth.ts:33
Claims to inject into request headers for upstream consumption
headerName?
Section titled “headerName?”
optionalheaderName:string
Defined in: src/policies/auth/jwt-auth.ts:29
Header to read the token from. Default: “Authorization”
issuer?
Section titled “issuer?”
optionalissuer:string
Defined in: src/policies/auth/jwt-auth.ts:25
Expected JWT issuer
jwksCacheTtlMs?
Section titled “jwksCacheTtlMs?”
optionaljwksCacheTtlMs:number
Defined in: src/policies/auth/jwt-auth.ts:35
JWKS cache TTL in milliseconds. Default: 300000 (5 minutes).
jwksTimeoutMs?
Section titled “jwksTimeoutMs?”
optionaljwksTimeoutMs:number
Defined in: src/policies/auth/jwt-auth.ts:37
JWKS fetch timeout in milliseconds. Default: 10000 (10 seconds).
jwksUrl?
Section titled “jwksUrl?”
optionaljwksUrl:string
Defined in: src/policies/auth/jwt-auth.ts:23
JWKS endpoint URL (e.g. Supabase, Auth0)
requireExp?
Section titled “requireExp?”
optionalrequireExp:boolean
Defined in: src/policies/auth/jwt-auth.ts:41
Require the exp claim to be present. Default: false.
secret?
Section titled “secret?”
optionalsecret:string
Defined in: src/policies/auth/jwt-auth.ts:21
JWT secret for HMAC verification
skip()?
Section titled “skip()?”
optionalskip: (c) =>boolean|Promise<boolean>
Defined in: 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”tokenPrefix?
Section titled “tokenPrefix?”
optionaltokenPrefix:string
Defined in: src/policies/auth/jwt-auth.ts:31
Token prefix. Default: “Bearer”