v10

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

Assignments

List KMS key assignments

Lists KMS key assignments. Results can be filtered by provider, key alias, party, service, purpose, or assignment status.

get/{tenantId}/kms/assignments

Query parameters

providerIdstring

Filter by provider id.

keyAliasstring

Filter by key alias.

partyIdstring

Filter by software party id.

serviceTypestring

Filter by service type.

serviceInstancestring

Filter by service instance id.

purposestring

Filter by assignment purpose.

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

Lifecycle status for a key assignment.

Filter by assignment status.

Response

Matching key assignments.

Example response

{
  "assignments": [
    {
      "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"
    }
  ]
}