Sign in

v11

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-065662751.8 MB
HMAC-auth credentials

Create a new HMAC-auth credential associated with a Consumer

Create a new HMAC-auth credential associated with a Consumer

post/{workspace}/consumers/{ConsumerIdForNestedEntities}/hmac-auth

Path parameters

ConsumerIdForNestedEntitiesstring required

Consumer ID for nested entities

workspacestring required
Example:team-payments

The name of the workspace

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 created 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"
}