Delete a Principal

Permanently deletes a principal from the directory.

delete

Path Parameters

directoryIdstring(uuid)required

ID of the directory

principalIdstring(uuid)required

Unique identifier of the principal (UUID format)

Response

Success

delete/directories/{directoryId}/principals/{principalId}
 

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.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Path Parameters

directoryIdstring(uuid)required

ID of the directory

principalIdstring(uuid)required

Unique identifier of the principal (UUID format)

Response

application/json

List of basic auth credentials

ListKongBasicAuths

metaobjectrequired
Show Child Parameters
dataarray[object]required

A basic auth credential associated with a principal, enabling username/password authentication.

Show Child Parameters
get/directories/{directoryId}/principals/{principalId}/basic-auths
 
application/json

Create a basic auth credential

Creates a new basic auth credential for the specified principal.

post

Path Parameters

directoryIdstring(uuid)required

ID of the directory

principalIdstring(uuid)required

Unique identifier of the principal (UUID format)

Body

application/json

Basic auth credential to be created

CreateBasicAuthBody

usernamestringrequired

The username for basic authentication.

>= 1 characters<= 255 characters

Response

application/json

A basic auth credential

KongBasicAuth

A basic auth credential associated with a principal, enabling username/password authentication.

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

usernamestringrequired

The username for basic authentication.

>= 1 characters<= 255 characters

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/directories/{directoryId}/principals/{principalId}/basic-auths

Body

{ "username": "username" }
 
application/json

Get a basic auth credential

Retrieves a specific basic auth credential by ID.

get

Path Parameters

directoryIdstring(uuid)required

ID of the directory

principalIdstring(uuid)required

Unique identifier of the principal (UUID format)

basicAuthIdstring(uuid)required

Unique identifier of the basic auth credential (UUID format)

Response

application/json

A basic auth credential

KongBasicAuth

A basic auth credential associated with a principal, enabling username/password authentication.

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

usernamestringrequired

The username for basic authentication.

>= 1 characters<= 255 characters

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/directories/{directoryId}/principals/{principalId}/basic-auths/{basicAuthId}
 
application/json