KMS Configuration

KMS Config Get

Get the specified KMS configuration. Returns metadata and, if your organization owns the configuration, the decrypted data.

get/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/get.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 decrypting a KMS configuration

idinteger required

KMS configuration ID

leasingAllowedboolean required

Is key leasing enabled?

assignmentCountinteger required

Number of consumers of the configuration.

secretCountinteger required

Number of active secrets associated with this configuration

createdstring required

RFC3339 timestamp

updatedstring required

RFC3339 timestamp

Example response

{
  "decryptedConfig": {
    "keyPath": {
      "keyID": "myKeyId",
      "region": "us-east"
    },
    "type": "AWS",
    "version": 1
  },
  "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.