Class JwkSet

constructor

• new JwkSet(
      jwkSet: {
          keys: {
              alg?: string;
              e?: string;
              key_ops?: string[];
              kid?: string;
              kty: string;
              n?: string;
              use?: string;
              x5c?: string[];
              x5t?: string;
              "x5t#S256"?: string;
              x5u?: string;
          }[];
      },
      options?: JwkSetOptions,
  ): JwkSet

  Parameters

  • jwkSet: {
        keys: {
            alg?: string;
            e?: string;
            key_ops?: string[];
            kid?: string;
            kty: string;
            n?: string;
            use?: string;
            x5c?: string[];
            x5t?: string;
            "x5t#S256"?: string;
            x5u?: string;
        }[];
    }
  • Optionaloptions: JwkSetOptions

  Returns JwkSet

Readonlykeys

isExpired

• get isExpired(): boolean

  A function for checking if a JWK set is expired.

  Returns boolean

  • a boolean based on if the JWK set is expired.

Staticfrom

• from(value: unknown, options?: JwkSetOptions): JwkSet

  Validates the input and converts it to a JwkSet.

  Parameters

  • value: unknown

    Any unknown value that is needing validation to use as a Jwk Set.

  • Optionaloptions: JwkSetOptions

    JwkSet options used to refresh the data.

  Returns JwkSet

  • A new JWK set which has been validated against the JWK set type.

Staticload

• load(jwkEndpoint: string | URL): Promise<JwkSet>

  A wrapper function for loading the jwk from the specified endpoint url. This function will pass in an expiration value to the from function.

  Parameters

  • jwkEndpoint: string | URL

    The endpoint from which the jwk is being fetched.

  Returns Promise<JwkSet>

  • output of the from function. A new JWK set which has been validated and with an expiration.