Sign in

v50

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-068428533.0 MB
Centrally Managed Keys

Create a key

This operation generates an API key for the specified consumer. The key is returned only at the time of creation and will not be retrievable in any subsequent GET requests on the entity.

The API supports two key creation types: new and legacy.

  • new: The recommended and more efficient option. The API automatically generates the key and returns it during this operation.
  • legacy: Allows you to provide your own secret. This approach has a performance impact when proxying requests, as it involves additional processing and resource usage.

Note: Regardless of the type selected, the key is only returned by the API when a key is created. It is not retrievable in the future.

post/v1/realms/{realmId}/consumers/{consumerId}/keys

Request body

type'new' | 'legacy' required
secretstring

secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated.

tagsstring[]

Example request

{
  "type": "new",
  "consumer_id": "...consumer_id...",
  "realm_id": "...realm_id..."
}

Response

success

idstring required
type'legacy' | 'new' required
secretstring required
created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

tagsstring[] required

Example response

{
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}