v10

latestOpenAPI 3.0.4raw.githubusercontent.com2026-07-0750111126.8 KB
KMS

Register an existing provider key for platform use

Explicitly onboards a key that already exists inside a provider into the platform's persistent key reference store, so the platform can discover and use it later. The body identifies the key by its providerId and alias, with an optional kid. This does not create or import key material; the key must already live in the named provider. The response confirms registration and echoes the alias, providerId, and kid. Returns 400 if the provider or key cannot be found.

post/keys/register

Request body

providerIdstring required

The provider that holds the key.

aliasstring required

Alias to register the key under.

kidstring

Optional kid for the key.

Example request

{
  "providerId": "4895d0cf-2061-41cb-8fd4-13af5724569e",
  "alias": "my-key-alias",
  "kid": "did:example:123#key-1"
}

Response

Key reference registered successfully

registeredboolean required

Whether the key was successfully registered.

aliasstring required

The alias the key was registered under.

providerIdstring required

The provider that holds the key.

kidstring

Optional kid for the key.

Example response

{
  "registered": true,
  "alias": "my-key-alias",
  "providerId": "4895d0cf-2061-41cb-8fd4-13af5724569e",
  "kid": "did:example:123#key-1"
}