Skip to content

activatekmssigningkeyresponsebody.md

Latest commit

 

History

History
35 lines (30 loc) · 13 KB

activatekmssigningkeyresponsebody.md

File metadata and controls

35 lines (30 loc) · 13 KB
Raw

ActivateKmsSigningKeyResponseBody

Example Usage

import { ActivateKmsSigningKeyResponseBody } from "@vercel/sdk/models/activatekmssigningkeyop.js";

let value: ActivateKmsSigningKeyResponseBody = {
  keyId: "<id>",
  issuerId: "<id>",
  algorithm: "<value>",
  status: "active",
  createdAt: "1709266686921",
  updatedAt: "1735645320869",
};

Fields

Field Type Required Description
keyId string ✔️ The server-minted, unique record identifier. Use this to address the key on the activate / certificate endpoints.
importKeyId string ➖ The caller-supplied key id (imported keys only), used as the JWT/JWKS kid. Not unique across an issuer's keys; omitted for generated keys.
issuerId string ✔️ N/A
algorithm string ✔️ N/A
status models.ActivateKmsSigningKeyStatus ✔️ N/A
publicKey models.ActivateKmsSigningKeyPublicKey ➖ N/A
publicKeyFingerprint string ➖ N/A
publicKeyPem string ➖ The public key in SPKI PEM form, ready to render. Present whenever the key has public key material. Derived from publicKey; the embedded certificate members (x5c/x5t#S256) do not affect it.
certificatePem string ➖ The stored X.509 certificate (from publicKey.x5c[0]) in PEM form, ready to render. Present only for keys created with a stored certificate; omitted for keys created before certificates were stored.
createdAt string ✔️ N/A
updatedAt string ✔️ N/A
revokeAt string ➖ N/A
activateAt string ➖ N/A
activatedAt string ➖ When the key became the active signer. Present for active and revoking keys (and absent for pending keys and rows predating this field).