IRironcorelabs
KMS Configuration

KMS Config List

List the metadata of all KMS configurations owned by the calling vendor.
This does not decrypt any of the sensitive KMS configuration data.

get/1/kms/configs

Request

Query parameters

sortColumn'assignments' | 'created' | 'updated'

Field to use for sorting

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

KMS to filter results to

leasingEnabledboolean

Key leasing status to filter results to

pageSizeinteger

Number of entries returned per page

pageinteger

Page number to return

sortDirection'asc' | 'desc'

Direction to sort

Headers

icl-requestor-idstring required

ID of requesting user/service

Response

Result of listing the vendor's KMS configurations

pageinteger required

Current response page number

totalPagesinteger required

Total number of response pages

Example response

{
  "tenant_configs": [
    {
      "id": 1,
      "kmsType": "AZURE",
      "version": 1,
      "createdBy": {
        "id": "string",
        "name": "string",
        "type": "Vaa"
      },
      "primary": true,
      "active": true,
      "leasingAllowed": true,
      "tenantId": "string",
      "created": "2022-01-13T21:44:43.653Z",
      "updated": "2022-01-13T21:44:43.653Z"
    }
  ],
  "vendor_configs": [
    {
      "id": 1,
      "kmsType": "AZURE",
      "version": 1,
      "createdBy": {
        "id": "string",
        "name": "string",
        "type": "Vaa"
      },
      "primary": true,
      "active": true,
      "leasingAllowed": true,
      "tenantId": "string",
      "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.