Get a HMAC-auth credential associated with a Consumer in a workspace

Get a HMAC-auth credential associated with a Consumer using ID in a workspace.

get

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

HMACAuthIdstringrequired

ID of the HMAC-auth credential to lookup

Example:70e7b00b-72f2-471b-a5ce-9c4171775360

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

Successfully fetched HMAC-auth credential

HMACAuth

* Additional properties are NOT allowed.
consumerobject
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
secretstring
tagsarray[string]

A string representing a tag.

usernamestringrequired
get/control-planes/{controlPlaneId}/core-entities/{workspace}/consumers/{ConsumerIdForNestedEntities}/hmac-auth/{HMACAuthId}
 
application/json

Upsert a HMAC-auth credential associated with a Consumer in a workspace

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

put

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

HMACAuthIdstringrequired

ID of the HMAC-auth credential to lookup

Example:70e7b00b-72f2-471b-a5ce-9c4171775360

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

Description of the HMAC-auth credential

HMACAuthWithoutParents

* Additional properties are NOT allowed.
consumerobject
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
secretstring
tagsarray[string]

A string representing a tag.

usernamestringrequired

Response

200 application/json

Successfully upserted HMAC-auth credential

HMACAuth

* Additional properties are NOT allowed.
consumerobject
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
secretstring
tagsarray[string]

A string representing a tag.

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

Body

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

List all HMAC-auth credentials in a workspace

List all HMAC-auth credentials in a workspace

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

A successful response listing HMAC-auth credentials

dataarray[object]

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

* Additional properties are NOT allowed.
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/control-planes/{controlPlaneId}/core-entities/{workspace}/hmac-auths
 
application/json

Get a HMAC-auth credential in a workspace

Get a HMAC-auth credential using ID in a workspace.

get

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

HMACAuthIdstringrequired

ID of the HMAC-auth credential to lookup

Example:70e7b00b-72f2-471b-a5ce-9c4171775360

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

Successfully fetched HMAC-auth credential

HMACAuth

* Additional properties are NOT allowed.
consumerobject
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
secretstring
tagsarray[string]

A string representing a tag.

usernamestringrequired
get/control-planes/{controlPlaneId}/core-entities/{workspace}/hmac-auths/{HMACAuthId}
 
application/json

List all HMAC-auth credentials associated with a Consumer

List all HMAC-auth credentials associated with a Consumer

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

200 application/json

A successful response listing HMAC-auth credentials

dataarray[object]

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

* Additional properties are NOT allowed.
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/hmac-auth
 
200 application/json