Create a new Basic-auth credential associated with a Consumer

Create a new Basic-auth credential 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 Basic-auth credential for creation

BasicAuthWithoutParents

* 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).

passwordstringrequired
tagsarray[string]

A string representing a tag.

usernamestringrequired

Response

201 application/json

Successfully created Basic-auth credential

BasicAuth

* 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).

passwordstringrequired
tagsarray[string]

A string representing a tag.

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

Body

{ "id": "b2f34145-0343-41a4-9602-4c69dec2f269", "password": "hashedsoopersecretvalue", "username": "darius" }
 
201 application/json

Delete a a Basic-auth credential associated with a Consumer

Delete a a Basic-auth credential associated with a Consumer using ID.

delete

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

BasicAuthIdstringrequired

ID of the Basic-auth credential to lookup

Example:80db1b58-ca7c-4d21-b92a-64eb07725872

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 Basic-auth credential or the resource didn’t exist

delete/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/basic-auth/{BasicAuthId}
 
204

Get a Basic-auth credential associated with a Consumer

Get a Basic-auth credential associated with a Consumer using ID.

get

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

BasicAuthIdstringrequired

ID of the Basic-auth credential to lookup

Example:80db1b58-ca7c-4d21-b92a-64eb07725872

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 Basic-auth credential

BasicAuth

* 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).

passwordstringrequired
tagsarray[string]

A string representing a tag.

usernamestringrequired
get/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/basic-auth/{BasicAuthId}
 
application/json

Upsert a Basic-auth credential associated with a Consumer

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

put

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

BasicAuthIdstringrequired

ID of the Basic-auth credential to lookup

Example:80db1b58-ca7c-4d21-b92a-64eb07725872

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 Basic-auth credential

BasicAuthWithoutParents

* 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).

passwordstringrequired
tagsarray[string]

A string representing a tag.

usernamestringrequired

Response

200 application/json

Successfully upserted Basic-auth credential

BasicAuth

* 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).

passwordstringrequired
tagsarray[string]

A string representing a tag.

usernamestringrequired
put/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/basic-auth/{BasicAuthId}

Body

{ "id": "b2f34145-0343-41a4-9602-4c69dec2f269", "password": "hashedsoopersecretvalue", "username": "darius" }
 
200 application/json

CA Certificates

A CA certificate object represents a trusted certificate authority.
These objects are used by Kong Gateway to verify the validity of a client or server certificate.