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
Authentication
Path Parameters
Update a basic auth credential
Partially updates an existing basic auth credential. Unspecified fields retain their current values.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Unique identifier of the basic auth credential (UUID format)
Body
application/json
Body
Basic auth credential to be partially updated
UpdateBasicAuthBody
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
Replace a basic auth credential
Fully replaces an existing basic auth credential with the provided values.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Unique identifier of the basic auth credential (UUID format)
Body
application/json
Body
Basic auth credential to be replaced
ReplaceBasicAuthBody
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
Delete a basic auth credential
Permanently deletes a basic auth credential and all associated passwords.
This operation cannot be undone.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Unique identifier of the basic auth credential (UUID format)
Response
Response
Success