List all API-keys associated with a Consumer

List all API-keys 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 API-keys

dataarray[object]

Example:{"consumer":{"id":"84a73fb8-50fc-44a7-a4d5-aa17728ee83f"},"id":"b2f34145-0343-41a4-9602-4c69dec2f269","key":"IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"}

* 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}/key-auth
 
200 application/json

Create a new API-key associated with a Consumer

Create a new API-key associated with a Consumer

post

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

Body

application/json

Description of new API-key for creation

KeyAuthWithoutParents

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

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

keystring
tagsarray[string]

A string representing a tag.

ttlinteger

key-auth ttl in seconds

Response

201 application/json

Successfully created API-key

KeyAuth

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

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

keystring
tagsarray[string]

A string representing a tag.

ttlinteger

key-auth ttl in seconds

post/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/key-auth

Body

{ "id": "b2f34145-0343-41a4-9602-4c69dec2f269", "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo" }
 
201 application/json

Delete a an API-key associated with a Consumer

Delete a an API-key associated with a Consumer using ID.

delete

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

KeyAuthIdstringrequired

ID of the API-key to lookup

controlPlaneIdstring(uuid)required

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

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

Response

204

Successfully deleted API-key or the resource didn’t exist

delete/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/key-auth/{KeyAuthId}
 
204

Get an API-key associated with a Consumer

Get an API-key associated with a Consumer using ID.

get

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

KeyAuthIdstringrequired

ID of the API-key to lookup

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 API-key

KeyAuth

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

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

keystring
tagsarray[string]

A string representing a tag.

ttlinteger

key-auth ttl in seconds

get/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/key-auth/{KeyAuthId}
 
application/json

Upsert an API-key associated with a Consumer

Create or Update an API-key associated with a Consumer using ID.

put

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

KeyAuthIdstringrequired

ID of the API-key to lookup

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 API-key

KeyAuthWithoutParents

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

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

keystring
tagsarray[string]

A string representing a tag.

ttlinteger

key-auth ttl in seconds

Response

200 application/json

Successfully upserted API-key

KeyAuth

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

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

keystring
tagsarray[string]

A string representing a tag.

ttlinteger

key-auth ttl in seconds

put/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/key-auth/{KeyAuthId}

Body

{ "id": "b2f34145-0343-41a4-9602-4c69dec2f269", "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo" }
 
200 application/json