KMS Configuration

KMS Config Update

Update the specified KMS configuration's encrypted data or enable/disable key leasing for the configuration. The configuration must be owned by the calling vendor.

put/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/put.ts
A function with typed inputs. Its response is checked against the schema.

Headers

icl-requestor-idstring required

ID of requesting user/service

Request body

leasingAllowedboolean

Wheather to allow key leasing for this configuration.

Example request

{
  "config": {
    "credentials": {
      "accessKeyId": "myAccessKeyId",
      "secretAccessKey": "mySecretAccessKey"
    },
    "type": "AWS",
    "version": 1
  }
}

Response

Result of updating a KMS configuration

idinteger required

KMS configuration ID

encryptedConfigstring required

Base 64 string

kmsType'AZURE' | 'AWS' | 'GCP' required

KMS type: AWS, Azure, or GCP

versioninteger required

Config version

leasingAllowedboolean required

Is key leasing enabled?

assignmentCountinteger required

Number of consumers of this configuration

secretCountinteger required

Number of active secrets associated with this configuration

createdstring required

RFC3339 timestamp

updatedstring required

RFC3339 timestamp

Example response

{
  "encryptedConfig": "AgA4eyJfZGlkXyI6IjVkMW",
  "kmsType": "AWS",
  "createdBy": {
    "id": "vendor",
    "name": "Vendor",
    "type": "Vaa"
  },
  "created": "2022-01-13T21:44:43.653Z",
  "updated": "2022-01-13T21:44:43.653Z"
}

Changes

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