Sign in

v10

latestOpenAPI 3.0.4raw.githubusercontent.com2026-07-0750111126.8 KB
Lifecycle

Upsert KMS key lifecycle metadata

Creates or updates lifecycle metadata for a managed key, including activation, deprecation, revoke scheduling, and rotation scheduling.

put/{tenantId}/kms/providers/{providerId}/keys/{keyAlias}/lifecycle

Request body

classification'PLATFORM' | 'TENANT' | 'APPLICATION' | 'SERVICE'

Operational ownership scope for tenant-managed infrastructure resources.

status'ACTIVE' | 'ROTATING' | 'ROTATED' | 'REVOKED' | 'DEPRECATED'

Lifecycle status for a KMS key or rotation record.

revokeAtstring date-time nullable
rotateAtstring date-time nullable
rotationIntervalstring nullable

ISO-8601 duration used for recurring rotation.

rotatedFromstring nullable
rotatedTostring nullable
targetProviderIdstring nullable

Example request

{
  "rotationInterval": "P3M"
}

Response

Key lifecycle metadata.

tenantIdstring required
providerIdstring required
keyAliasstring required
classification'PLATFORM' | 'TENANT' | 'APPLICATION' | 'SERVICE'

Operational ownership scope for tenant-managed infrastructure resources.

status'ACTIVE' | 'ROTATING' | 'ROTATED' | 'REVOKED' | 'DEPRECATED' required

Lifecycle status for a KMS key or rotation record.

revokeAtstring date-time nullable
rotateAtstring date-time nullable
rotationIntervalstring nullable

ISO-8601 duration used for recurring rotation.

rotatedFromstring nullable

Source key alias when this key was created by rotation.

rotatedTostring nullable

Replacement key alias after rotation.

targetProviderIdstring nullable

Target provider id for scheduled cross-KMS rotation.

updatedAtstring date-time nullable

Example response

{
  "tenantId": "tenant-001",
  "providerId": "software",
  "keyAlias": "as-signing",
  "revokeAt": "2026-12-18T10:15:30Z",
  "rotateAt": "2026-09-18T10:15:30Z",
  "rotationInterval": "P3M",
  "rotatedFrom": "as-signing-20260618101530",
  "rotatedTo": "as-signing-20260918101530",
  "targetProviderId": "azure-key-vault",
  "updatedAt": "2026-06-18T10:15:30Z"
}