JWTClaimVerificationOptions

fmgp.typings.jose.typesMod.JWTClaimVerificationOptions
See theJWTClaimVerificationOptions companion object
trait JWTClaimVerificationOptions extends StObject

Attributes

Companion
object
Graph
Supertypes
trait StObject
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Value members

Inherited methods

def hasOwnProperty(v: String): Boolean

Attributes

Inherited from:
Object
def isPrototypeOf(v: Object): Boolean

Attributes

Inherited from:
Object
def propertyIsEnumerable(v: String): Boolean

Attributes

Inherited from:
Object
def toLocaleString(): String

Attributes

Inherited from:
Object
def valueOf(): Any

Attributes

Inherited from:
Object

Concrete fields

var audience: UndefOr[String | Array[String]]

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

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

Attributes

var clockTolerance: UndefOr[String | Double]

Expected clock tolerance

Expected clock tolerance

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

Attributes

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

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

Attributes

var issuer: UndefOr[String | Array[String]]

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

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

Attributes

var maxTokenAge: UndefOr[String | Double]

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

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").

Attributes

var requiredClaims: UndefOr[Array[String]]

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

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

Attributes

var subject: UndefOr[String]

Expected JWT "sub" (Subject) Claim value.

Expected JWT "sub" (Subject) Claim value.

Attributes

var typ: UndefOr[String]

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

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

Attributes