jose/docs/interfaces/types.jwtclaimverificationoptions.md

Interface: JWTClaimVerificationOptions

types.JWTClaimVerificationOptions

JWT Claims Set verification options.

Hierarchy

• JWTClaimVerificationOptions

  ↳ JWTDecryptOptions

  ↳ JWTVerifyOptions

Table of contents

Properties

• audience
• clockTolerance
• currentDate
• issuer
• maxTokenAge
• subject
• typ

Properties

audience

• Optional audience: string | string[]

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

Defined in: types.d.ts:475

---

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:482

---

currentDate

• Optional currentDate: Date

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

Defined in: types.d.ts:509

---

issuer

• Optional issuer: string | string[]

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

Defined in: types.d.ts:487

---

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:494

---

subject

• Optional subject: string

Expected JWT "sub" (Subject) Claim value.

Defined in: types.d.ts:499

---

typ

• Optional typ: string

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

Defined in: types.d.ts:504