Skip to content

JwtAuthConfig

Defined in: src/policies/auth/jwt-auth.ts:11

Configuration for the jwtAuth policy.

optional audience: string

Defined in: src/policies/auth/jwt-auth.ts:19

Expected JWT audience


optional clockSkewSeconds: number

Defined in: src/policies/auth/jwt-auth.ts:31

Clock skew tolerance in seconds for expiry checks. Default: 0.


optional forwardClaims: Record<string, string>

Defined in: src/policies/auth/jwt-auth.ts:25

Claims to inject into request headers for upstream consumption


optional headerName: string

Defined in: src/policies/auth/jwt-auth.ts:21

Header to read the token from. Default: “Authorization”


optional issuer: string

Defined in: src/policies/auth/jwt-auth.ts:17

Expected JWT issuer


optional jwksCacheTtlMs: number

Defined in: src/policies/auth/jwt-auth.ts:27

JWKS cache TTL in milliseconds. Default: 300000 (5 minutes).


optional jwksTimeoutMs: number

Defined in: src/policies/auth/jwt-auth.ts:29

JWKS fetch timeout in milliseconds. Default: 10000 (10 seconds).


optional jwksUrl: string

Defined in: src/policies/auth/jwt-auth.ts:15

JWKS endpoint URL (e.g. Supabase, Auth0)


optional requireExp: boolean

Defined in: src/policies/auth/jwt-auth.ts:33

Require the exp claim to be present. Default: false.


optional secret: string

Defined in: src/policies/auth/jwt-auth.ts:13

JWT secret for HMAC verification


optional skip: (c) => boolean | Promise<boolean>

Defined in: src/policies/types.ts:33

Skip this policy when condition returns true

unknown

boolean | Promise<boolean>

PolicyConfig.skip


optional tokenPrefix: string

Defined in: src/policies/auth/jwt-auth.ts:23

Token prefix. Default: “Bearer”