TokenOptions

TokenOptions describes the claims carried by a Token.

Properties

algorithm?

readonly optional algorithm?: string

algorithm is the alg header value.

---

audience?

readonly optional audience?: readonly string[]

audience is the aud claim, always held as a list.

---

authorizedParty?

readonly optional authorizedParty?: string

authorizedParty is the azp claim, or the empty string when absent.

---

expiresAt?

readonly optional expiresAt?: Timestamp

expiresAt is the exp claim, or the unset timestamp when absent.

---

id?

readonly optional id?: string

id is the jti claim, or the empty string when absent.

---

issuedAt?

readonly optional issuedAt?: Timestamp

issuedAt is the iat claim, or the unset timestamp when absent.

---

issuer?

readonly optional issuer?: string

issuer is the iss claim.

---

keyId?

readonly optional keyId?: string

keyId is the kid header value, or the empty string when absent.

---

notBefore?

readonly optional notBefore?: Timestamp

notBefore is the nbf claim, or the unset timestamp when absent.

---

payload?

readonly optional payload?: Record<string, unknown>

payload contains the decoded claim set, including custom claims.

---

subject?

readonly optional subject?: string

subject is the sub claim.