Module

x/jose/types.d.ts>JWTClaimVerificationOptions

"JSON Web Almost Everything" - JWA, JWS, JWE, JWT, JWK, JWKS for Node.js, Browser, Cloudflare Workers, Deno, Bun, and other Web-interoperable runtimes.
panva/jose
Extremely Popular
Go to Latest
interface JWTClaimVerificationOptions
import { type JWTClaimVerificationOptions } from "https://dotland.deno.dev/x/jose@v4.15.1/types.d.ts";

JWT Claims Set verification options.

Properties

optional
audience: string | string[]

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

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").
optional
issuer: string | string[]

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

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").
optional
subject: string

Expected JWT "sub" (Subject) Claim value.

optional
typ: string

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

optional
currentDate: Date

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

optional
requiredClaims: string[]

Array of required Claim Names that must be present in the JWT Claims Set. Default is that: if the {@link JWTClaimVerificationOptions.issuer | issuer option} is set, then "iss" must be present; if the {@link JWTClaimVerificationOptions.audience | audience option} is set, then "aud" must be present; if the {@link JWTClaimVerificationOptions.subject | subject option} is set, then "sub" must be present; if the {@link JWTClaimVerificationOptions.maxTokenAge | maxTokenAge option} is set, then "iat" must be present.