Tenant Secret

Tenant Secret List

List secrets associated with the vendor's tenants

get/1/tenants/secrets

Request

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

Query parameters

updatedSincestring date-time

RFC3339 timestamp

createdSincestring date-time

RFC3339 timestamp

secretType'search' | 'deterministic-encryption' | 'vector'

Tenant secret type to filter to

migrationStatus'current' | 'needs-migration'

Tenant secret migration status to filter to

rotationStatus'current' | 'in-rotation' | 'archived'

Tenant secret rotation status to filter to

pageinteger

Page number to return

pageSizeinteger

Number of entries returned per page

sortDirection'asc' | 'desc'

Direction to sort

sortColumn'created' | 'updated'

Column to use for sorting

querystring

Tenant provided ID, secret path, secret fingerprint, or KMS config ID to search for

Headers

icl-requestor-idstring required

ID of requesting user/service

Request body

idsTenantSecretId[]

Tenant secret IDs to filter to

tagsTagId[]

Response

Result of listing tenant secrets

pageinteger required

Current response page number

totalPagesinteger required

Total number of response pages

Example response

{
  "result": [
    {
      "encryptedSecret": "AgA4eyJfZGlkXyI6IjVkMW",
      "tenantId": "tenant-icl",
      "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.