jose/docs/interfaces/_jwt_verify_.jwtverifyoptions.md
2020-12-02 10:00:42 +01:00

2.4 KiB

Interface: JWTVerifyOptions

Combination of JWS Verification options and JWT Claims Set verification options.

Index

Properties

Properties

algorithms

Optional algorithms: string[]

Defined in src/types.d.ts:397

A list of accepted JWS "alg" (Algorithm) Header Parameter values.


audience

Optional audience: string | string[]

Defined in src/types.d.ts:355

Expected JWT "aud" (Audience) Claim value(s).


clockTolerance

Optional clockTolerance: string | number

Defined in src/types.d.ts:362

Expected clock tolerance

  • in seconds when number (e.g. 5)
  • parsed as seconds when a string (e.g. "5 seconds").

currentDate

Optional currentDate: Date

Defined in src/types.d.ts:387

Date to use when comparing NumericDate claims, defaults to new Date().


issuer

Optional issuer: string | string[]

Defined in src/types.d.ts:367

Expected JWT "iss" (Issuer) Claim value(s).


maxTokenAge

Optional maxTokenAge: string

Defined in src/types.d.ts:372

Maximum time elapsed (in seconds) from the JWT "iat" (Issued At) Claim value.


subject

Optional subject: string

Defined in src/types.d.ts:377

Expected JWT "sub" (Subject) Claim value.


typ

Optional typ: string

Defined in src/types.d.ts:382

Expected JWT "typ" (Type) Header Parameter value.