Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IronCore Labs Tenant Secret API

Tenant secrets created by the TSP and stored in the Config Broker

IronCore Labs Tenant Secret API is one of 5 APIs that IronCore Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Tenant Secret. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 3 operations across 3 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 3.1.0.

Requests are made against a single base URL, http://localhost:3000/api.

3 operations 3 paths 11 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.1.0
Base URL
https://ironcorelabs.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

IronCore Labs Tenant Secret API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization). By default, every request must be authenticated.

  • Authorization — VAB authorization header. Form: vab:1:

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Tenant Secret 3

Tenant secrets created by the TSP and stored in the Config Broker

GET
/1/tenants/secrets
Tenant Secret List
post-1-tenants-secrets 11 params body → 200401
POST
/1/tenants/{tenantId}/secrets/rotate/begin
Tenant Secret Rotation Begin
post-1-tenants-tenantId-secrets-rotate-begin 2 params body → 200
POST
/1/tenants/{tenantId}/secrets/rotate/commit
Tenant Secret Rotation Commit
post-1-tenants-tenantId-secrets-rotate-commit 2 params body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are TenantSecretListResponseItem (12 properties), TenantSecret (10 properties). Each schema is shown below with its type and property counts.

TenantSecretListResponseItem
object
Tenant secret and associated tenant
12 properties 12 required
Base64
string
Base 64 string
KmsConfigId
integer
KMS configuration ID
TenantSecretType
string
Tenant secret type
TenantSecret
object
Tenant secret
10 properties 10 required
TenantSecretRotationStatus
string
Tenant secret rotation status
TenantSecretMigrationStatus
string
Tenant secret migration status
TenantSecretId
integer
Tenant Secret ID
TagId
integer
Tag ID
Timestamp
string
RFC3339 timestamp
TenantId
string
Tenant ID

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ironcore-labs-tenant-secret-api-openapi.yml Raw ↑

Other APIs IronCore Labs publishes across the network.

IronCore Labs Configuration Assignment API
IronCore Labs KMS Configuration API
IronCore Labs Tag API
IronCore Labs Tenant API