jose/docs/interfaces/types.JWTClaimVerificationOptions.md
2021-08-20 22:40:04 +02:00

2.5 KiB

Interface: JWTClaimVerificationOptions

types.JWTClaimVerificationOptions

JWT Claims Set verification options.

Hierarchy

Table of contents

Properties

Properties

audience

Optional audience: string | string[]

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

Defined in

types.d.ts:486


clockTolerance

Optional clockTolerance: string | number

Expected clock tolerance

  • in seconds when number (e.g. 5)
  • parsed as seconds when a string (e.g. "5 seconds", "10 minutes", "2 hours").

Defined in

types.d.ts:493


currentDate

Optional currentDate: Date

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

Defined in

types.d.ts:520


issuer

Optional issuer: string | string[]

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

Defined in

types.d.ts:498


maxTokenAge

Optional maxTokenAge: string | number

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

  • in seconds when number (e.g. 5)
  • parsed as seconds when a string (e.g. "5 seconds", "10 minutes", "2 hours").

Defined in

types.d.ts:505


subject

Optional subject: string

Expected JWT "sub" (Subject) Claim value.

Defined in

types.d.ts:510


typ

Optional typ: string

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

Defined in

types.d.ts:515