Sign in

v61

OpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB
HMAC-auth credentials

Upsert a HMAC-auth credential associated with a Consumer

Create or Update a HMAC-auth credential associated with a Consumer using ID.

put/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/hmac-auth/{HMACAuthId}

Path parameters

ConsumerIdForNestedEntitiesstring required

Consumer ID for nested entities

HMACAuthIdstring required

ID of the HMAC-auth credential to lookup

Request body

created_atinteger nullable

Unix epoch when the resource was created.

idstring nullable

A string representing a UUID (universally unique identifier).

secretstring nullable
tagsstring[] nullable

A set of strings representing tags.

usernamestring required

Example request

{
  "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  "username": "xerxes"
}

Response

Successfully upserted HMAC-auth credential

created_atinteger nullable

Unix epoch when the resource was created.

idstring nullable

A string representing a UUID (universally unique identifier).

secretstring nullable
tagsstring[] nullable

A set of strings representing tags.

usernamestring required

Example response

{
  "consumer": {
    "id": "84a73fb8-50fc-44a7-a4d5-aa17728ee83f"
  },
  "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  "username": "xerxes"
}