Hanzo
OpenapiKms

Returns the runtime configuration for the KMS console.

Returns the runtime configuration for the KMS console.

GET /v1/kms/config

Addresshttps://api.hanzo.ai/v1/kms/config
MethodGET
Operationget_kms_config
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the runtime configuration for the KMS console.

What the console needs before anyone has signed in: the brand, the OIDC issuer it authenticates against, the API base for this subsystem and the path of the login exchange.

Public on purpose, and it holds nothing sensitive — it is deliberately kept under this subsystem's own namespace rather than under an admin prefix, so a gateway that admin-gates the admin routes cannot break the console's legitimate pre-login fetch.

Request

GET /v1/kms/config takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200kmsConfigok

200 body — 4 fields.

FieldInTypeAlwaysDescription
apiBasebodystringAPIBase is this subsystem's own prefix, /v1/kms.
brandbodystringBrand is the deployment's brand, so the console renders as the right product.
issuerbodystringIssuer is the OIDC issuer the console authenticates against.
loginPathbodystringLoginPath is the credential exchange's address.

Failure carries the platform error shape — see Errors.

Examples

hanzo kms config

KMS API · All Hanzo APIs · Interactive reference

How is this guide?

On this page