v10

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

Assignments

Unassign a KMS key assignment

Marks an assignment inactive, revoked, or rotated without deleting key material. Assignment state affects service key resolution and key deletion protection.

patch/{tenantId}/kms/assignments/{assignmentId}

Request body

status'ACTIVE' | 'ROTATED' | 'REVOKED' | 'INACTIVE'

Lifecycle status for a key assignment.

Response

Updated key assignment.

assignmentIdstring required

tenantIdstring required

providerIdstring required

keyAliasstring required

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

Operational ownership scope for tenant-managed infrastructure resources.

serviceTypestring nullable

serviceInstancestring nullable

partyIdstring nullable

relationshipTypestring nullable

purposestring required

validFromstring date-time nullable

validUntilstring date-time nullable

status'ACTIVE' | 'ROTATED' | 'REVOKED' | 'INACTIVE' required

Lifecycle status for a key assignment.

targetProviderIdstring nullable

createdAtstring date-time nullable

updatedAtstring date-time nullable

Example response

{
  "assignmentId": "assignment-001",
  "tenantId": "tenant-001",
  "providerId": "software",
  "keyAlias": "as-signing",
  "serviceType": "oauth2-as",
  "serviceInstance": "as-main",
  "partyId": "party-issuer-001",
  "relationshipType": "SOFTWARE_SERVICE",
  "purpose": "as-signing",
  "validFrom": "2026-06-18T10:15:30Z",
  "validUntil": "2026-12-18T10:15:30Z",
  "targetProviderId": "azure-key-vault",
  "createdAt": "2026-06-18T10:15:30Z",
  "updatedAt": "2026-06-18T10:15:30Z"
}