JWTVerifyOptions

fmgp.typings.jose.jwtVerifyMod.JWTVerifyOptions
See theJWTVerifyOptions companion object

Attributes

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

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

Inherited fields

var algorithms: UndefOr[Array[String]]

A list of accepted JWS "alg" (Algorithm) Header Parameter values. By default all "alg" (Algorithm) values applicable for the used key/secret are allowed. Note: "none" is never accepted.

A list of accepted JWS "alg" (Algorithm) Header Parameter values. By default all "alg" (Algorithm) values applicable for the used key/secret are allowed. Note: "none" is never accepted.

Attributes

Inherited from:
VerifyOptions
var audience: UndefOr[String | Array[String]]

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

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

Attributes

Inherited from:
JWTClaimVerificationOptions
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

Inherited from:
JWTClaimVerificationOptions
var crit: UndefOr[StringDictionary[Boolean]]

An object with keys representing recognized "crit" (Critical) Header Parameter names. The value for those is either true or false. true when the Header Parameter MUST be integrity protected, false when it's irrelevant.

An object with keys representing recognized "crit" (Critical) Header Parameter names. The value for those is either true or false. true when the Header Parameter MUST be integrity protected, false when it's irrelevant.

This makes the "Extension Header Parameter "..." is not recognized" error go away.

Use this when a given JWS/JWT/JWE profile requires the use of proprietary non-registered "crit" (Critical) Header Parameters. This will only make sure the Header Parameter is syntactically correct when provided and that it is optionally integrity protected. It will not process the Header Parameter in any way or reject the operation if it is missing. You MUST still verify the Header Parameter was present and process it according to the profile's validation steps after the operation succeeds.

The JWS extension Header Parameter b64 is always recognized and processed properly. No other registered Header Parameters that need this kind of default built-in treatment are currently available.

Attributes

Inherited from:
CritOption

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

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

Attributes

Inherited from:
JWTClaimVerificationOptions
var issuer: UndefOr[String | Array[String]]

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

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

Attributes

Inherited from:
JWTClaimVerificationOptions
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

Inherited from:
JWTClaimVerificationOptions
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

Inherited from:
JWTClaimVerificationOptions
var subject: UndefOr[String]

Expected JWT "sub" (Subject) Claim value.

Expected JWT "sub" (Subject) Claim value.

Attributes

Inherited from:
JWTClaimVerificationOptions
var typ: UndefOr[String]

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

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

Attributes

Inherited from:
JWTClaimVerificationOptions