Get a password
Retrieves a specific password by ID. The password value is not returned.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Unique identifier of the basic auth credential (UUID format)
Unique identifier of the password (UUID format)
Response
application/json
Response
A password
KongPassword
A password credential associated with a basic auth entry. The password value is not returned after creation.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
An ISO-8601 timestamp representation of entity expiration date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update a password
Partially updates a password’s expiration date.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Unique identifier of the basic auth credential (UUID format)
Unique identifier of the password (UUID format)
Body
application/json
Body
Password to be partially updated
UpdatePasswordBody
Request body for partially updating a password
An ISO-8601 timestamp representation of entity expiration date.
Example:2022-11-04T20:10:06.927Z
Response
application/json
Response
A password
KongPassword
A password credential associated with a basic auth entry. The password value is not returned after creation.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
An ISO-8601 timestamp representation of entity expiration date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Replace a password
Fully replaces an existing password 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)
Unique identifier of the password (UUID format)
Body
application/json
Body
Password to be replaced
ReplacePasswordBody
Request body for replacing a password
>= 1 characters<= 255 characters
An ISO-8601 timestamp representation of entity expiration date.
Example:2022-11-04T20:10:06.927Z
Response
application/json
Response
A password
KongPassword
A password credential associated with a basic auth entry. The password value is not returned after creation.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
An ISO-8601 timestamp representation of entity expiration date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete a password
Permanently deletes a password, immediately revoking its access.
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)
Unique identifier of the password (UUID format)
Response
Response
Success
Authentication
Path Parameters
Create a principal API key
Creates a new API key for the specified principal.
Keys can be system-generated (v1) or imported with a custom secret, and may have an optional expiration date.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Body
application/json
Body
Key to be created
CreatePrincipalKeyBody
One OfAllowed values:imported
>= 1 characters<= 255 characters
An ISO-8601 timestamp representation of entity expiration date.
Example:2022-11-04T20:10:06.927Z
Response
application/json
Response
A Kong Principal Key
KongPrincipalKeyWithSecret
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
An ISO-8601 timestamp representation of entity expiration date.
Example:2022-11-04T20:10:06.927Z
The API key secret value. This is only returned when the key is first created
and cannot be retrieved again later.