KMS Configuration

KMS Config Delete

Delete the specified KMS configuration. In order to succeed, the configuration must be owned by the calling vendor and not have any tenant assignments.

This API allows for destructively offboarding a tenant with active secrets. Secrets are not recoverable and any downstream services (Deterministic Encryption, Cloaked Search) will fail when attempting to do things with those secrets. We strongly advise checking for secret_count == 0 before issuing a KMS Configuration DELETE.

delete/1/kms/configs/{kmsConfigId}

Request

Base URL
http://localhost:3000/api
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/docs/1/kms/configs/:kmsConfigId/delete.ts
A function with typed inputs. Its response is checked against the schema.

Headers

icl-requestor-idstring required

ID of requesting user/service

Response

Result of deleting a KMS configuration

idinteger required

KMS configuration ID

Example response

{
  "id": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.