openid-client/docs/interfaces/PrivateKey.md

Interface: PrivateKey

💗 Help the project

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

---

Interface to pass an asymmetric private key and, optionally, its associated JWK Key ID to be added as a kid JOSE Header Parameter.

Properties

key

• key: CryptoKey

An asymmetric private CryptoKey.

Its algorithm must be compatible with a supported JWS Algorithm.

---

kid?

• optional kid?: string

JWK Key ID to add to JOSE headers when this key is used. When not provided no kid (JWK Key ID) will be added to the JOSE Header.