Select the key-protection backend type for a managed tier (platform)

Sets which of the nine declarable key-protection backends a licensed tier uses. The tier transitions through BINDING and lands in DECLARED_PENDING_BIND — selecting a type declares an intent, it does not bind a backend, so the tier does NOT become ACTIVE here. A mechanism this deployment does not OFFER right now is refused 422 before anything else is evaluated (see the 422 below), and the tier listing reports that same verdict per token as offered, from the same composition, so a picker cannot present an option this operation refuses. When the selected backend provides LOWER custody assurance than the tier's name implies (for example ENTERPRISE on softhsm), the change is refused 422 unless assuranceDowngradeConfirmed is set; a same-or-higher-assurance selection needs no confirmation. A selection that would MOVE the tier's resolved key-encryption key is refused 409 while any tenant on that tier holds key material; a selection that provably does not move it — re-selecting the type the tier already holds — is permitted even then. blastRadiusAcknowledged records that the operator was shown, and accepted, how many tenants the change actually moves — that is assignedTenantCount, not the edition's total; it is recorded on the audit row and is not itself a gate, so omitting it is recorded as false and refuses nothing. Every accepted change emits a signed admin audit event carrying who, when, the tier, the from-to transition and both acknowledgements. This request carries no credential and no PIN. Required scope: admin.platform.key-backend.tier.manage.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

The licensed tier to configure.

Allowed:
Body Params

Selects the ANKA-managed key-protection backend type for one licensed tier. Carries only the backend token and the downgrade acknowledgement — never a credential or PIN.

string
enum
required
length ≥ 1
^(?i)(SOFTHSM|NSHIELD|LUNA|CLOUDHSM|AWS-KMS|GCP-KMS|GCP-KMS-HSM|AZURE-KV|AZURE-KV-MHSM)$

Key-protection backend from the closed nine-value set (4 PKCS#11 HSM vendors + 5 Cloud KMS backends). Accepted case-insensitively and persisted as the lowercase slug.

boolean
Defaults to false

Explicit acceptance that the selected backend provides LOWER custody assurance than this tier's name implies. Needed only for such a downgrade, which is otherwise refused 422; a same-or-higher-assurance selection needs no confirmation.

boolean
Defaults to false

The operator's acknowledgement of this change's blast radius — how many tenants the platform will actually move, which is assignedTenantCount and not the edition's total. Recorded on the audit row beside assuranceDowngradeConfirmed. It does not weaken the key-material refusal, and it is not itself a gate: absence is recorded as false, never refused.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json