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.
Authentication
Path Parameters
Body
List all API keys for a principal
Retrieves a paginated list of all API keys associated with the specified principal.
Results can be sorted by created_at, updated_at, or name.
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
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Response
application/json
Response
List Kong Principal Keys
ListKongPrincipalKeys
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Update a principal API key
Partially updates an existing API key’s metadata.
Note: The key secret cannot be modified after creation.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Unique identifier of the API key (UUID format)
Body
application/json
Body
Key to be updated
UpdatePrincipalKeyBody
Request body for updating an API key’s metadata
An ISO-8601 timestamp representation of entity expiration date.
Example:2022-11-04T20:10:06.927Z
Response
application/json
Response
A Kong Principal Key
KongPrincipalKey
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