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

Update a basic auth credential

Partially updates an existing basic auth credential. Unspecified fields retain their current values.

patch

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)

Body

application/json

Basic auth credential to be partially updated

UpdateBasicAuthBody

usernamestring

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

patch/directories/{directoryId}/principals/{principalId}/basic-auths/{basicAuthId}

Body

{}
 
application/json

Replace a basic auth credential

Fully replaces an existing basic auth credential with the provided values.

put

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)

Body

application/json

Basic auth credential to be replaced

ReplaceBasicAuthBody

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

put/directories/{directoryId}/principals/{principalId}/basic-auths/{basicAuthId}

Body

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

Delete a basic auth credential

Permanently deletes a basic auth credential and all associated passwords.
This operation cannot be undone.

delete

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

Success

delete/directories/{directoryId}/principals/{principalId}/basic-auths/{basicAuthId}