Sign in

v10

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

Assign a KMS key to a service or party

Creates an assignment that links a KMS key to a service, service instance, optional software party, relationship type, and purpose. Assignments are separate from key material and are used for service key resolution, deletion protection, and rotation transfer.

post/{tenantId}/kms/providers/{providerId}/keys/{keyAlias}/assignments

Request body

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

Response

Created 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"
}