Class SignRequestResponseJWT

Hierarchy

  • SignJWT
    • SignRequestResponseJWT

Constructors

Properties

_payload: JWTPayload

Methods

  • Set the "aud" (Audience) Claim.

    Parameters

    • audience: string | string[]

      "aud" (Audience) Claim value to set on the JWT Claims Set.

    Returns this

  • Set the "exp" (Expiration Time) Claim.

    • If a number is passed as an argument it is used as the claim directly.
    • If a Date instance is passed as an argument it is converted to unix timestamp and used as the claim.
    • If a string is passed as an argument it is resolved to a time span, and then added to the current unix timestamp and used as the claim.

    Format used for time span should be a number followed by a unit, such as "5 minutes" or "1 day".

    Valid units are: "sec", "secs", "second", "seconds", "s", "minute", "minutes", "min", "mins", "m", "hour", "hours", "hr", "hrs", "h", "day", "days", "d", "week", "weeks", "w", "year", "years", "yr", "yrs", and "y". It is not possible to specify months. 365.25 days is used as an alias for a year.

    If the string is suffixed with "ago", or prefixed with a "-", the resulting time span gets subtracted from the current unix timestamp. A "from now" suffix can also be used for readability when adding to the current unix timestamp.

    Parameters

    • input: string | number | Date

      "exp" (Expiration Time) Claim value to set on the JWT Claims Set.

    Returns this

  • Set the "iat" (Issued At) Claim.

    • If no argument is used the current unix timestamp is used as the claim.
    • If a number is passed as an argument it is used as the claim directly.
    • If a Date instance is passed as an argument it is converted to unix timestamp and used as the claim.
    • If a string is passed as an argument it is resolved to a time span, and then added to the current unix timestamp and used as the claim.

    Format used for time span should be a number followed by a unit, such as "5 minutes" or "1 day".

    Valid units are: "sec", "secs", "second", "seconds", "s", "minute", "minutes", "min", "mins", "m", "hour", "hours", "hr", "hrs", "h", "day", "days", "d", "week", "weeks", "w", "year", "years", "yr", "yrs", and "y". It is not possible to specify months. 365.25 days is used as an alias for a year.

    If the string is suffixed with "ago", or prefixed with a "-", the resulting time span gets subtracted from the current unix timestamp. A "from now" suffix can also be used for readability when adding to the current unix timestamp.

    Parameters

    • Optional input: string | number | Date

      "iat" (Expiration Time) Claim value to set on the JWT Claims Set.

    Returns this

  • Set the "iss" (Issuer) Claim.

    Parameters

    • issuer: string

      "Issuer" Claim value to set on the JWT Claims Set.

    Returns this

  • Set the "jti" (JWT ID) Claim.

    Parameters

    • jwtId: string

      "jti" (JWT ID) Claim value to set on the JWT Claims Set.

    Returns this

  • Set the "nbf" (Not Before) Claim.

    • If a number is passed as an argument it is used as the claim directly.
    • If a Date instance is passed as an argument it is converted to unix timestamp and used as the claim.
    • If a string is passed as an argument it is resolved to a time span, and then added to the current unix timestamp and used as the claim.

    Format used for time span should be a number followed by a unit, such as "5 minutes" or "1 day".

    Valid units are: "sec", "secs", "second", "seconds", "s", "minute", "minutes", "min", "mins", "m", "hour", "hours", "hr", "hrs", "h", "day", "days", "d", "week", "weeks", "w", "year", "years", "yr", "yrs", and "y". It is not possible to specify months. 365.25 days is used as an alias for a year.

    If the string is suffixed with "ago", or prefixed with a "-", the resulting time span gets subtracted from the current unix timestamp. A "from now" suffix can also be used for readability when adding to the current unix timestamp.

    Parameters

    • input: string | number | Date

      "nbf" (Not Before) Claim value to set on the JWT Claims Set.

    Returns this

  • Sets the JWS Protected Header on the SignJWT object.

    Parameters

    • protectedHeader: JWTHeaderParameters

      JWS Protected Header. Must contain an "alg" (JWS Algorithm) property.

    Returns this

  • Set the "sub" (Subject) Claim.

    Parameters

    • subject: string

      "sub" (Subject) Claim value to set on the JWT Claims Set.

    Returns this

  • Parameters

    • key: KeyLike
    • Optional options: SignOptions

    Returns Promise<string>