Vaults

Get a vault's public key for browser-encrypted credential values

Changed on

Returns the public key that custom credential collection web apps use to encrypt values in the browser. Use this only if you run your own credential collection web app and want values encrypted in the browser, sent to your backend still encrypted, and forwarded to Kernel's API still encrypted. In every other case, including server-side code that already holds the plaintext, use value. The page encrypts each value to this key, your backend forwards the ciphertext unchanged as encrypted_value when creating or updating a credential item in this vault, and Kernel decrypts it.

get/vaults/{id_or_name}/encryption_key

Request

  • Base URL
    https://api.onkernel.com
  • URL
    https://api.onkernel.com/vaults/{id_or_name}/encryption_key
  • Auth
    HTTP bearer

Response

Vault encryption key

alg'ECDH-ES' required

JWE key management algorithm.

enc'A256GCM' required

JWE content encryption algorithm.

kidstring required

Key ID. Set it as the kid protected header of every encrypted_value.

Changes