Delete a Principal
Permanently deletes a principal from the directory.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Response
Response
Success
Authentication
Path Parameters
KongPrincipalCredential
Credentials are authentication secrets associated with principals. Supported credential types are
API keys (system-generated or imported) and basic auth username/password pairs.
List all basic auth credentials
Retrieves a paginated list of all basic auth credentials associated with the specified principal.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item before this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Response
application/json
Response
List of basic auth credentials
ListKongBasicAuths
Show Child Parameters
A basic auth credential associated with a principal, enabling username/password authentication.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create a basic auth credential
Creates a new basic auth credential for the specified principal.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Body
application/json
Body
Basic auth credential to be created
CreateBasicAuthBody
The username for basic authentication.
>= 1 characters<= 255 characters
Response
application/json
Response
A basic auth credential
KongBasicAuth
A basic auth credential associated with a principal, enabling username/password authentication.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The username for basic authentication.
>= 1 characters<= 255 characters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Get a basic auth credential
Retrieves a specific basic auth credential by ID.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Unique identifier of the basic auth credential (UUID format)
Response
application/json
Response
A basic auth credential
KongBasicAuth
A basic auth credential associated with a principal, enabling username/password authentication.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The username for basic authentication.
>= 1 characters<= 255 characters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z