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}
 

List all passwords for a basic auth

Retrieves a paginated list of all passwords associated with the specified basic auth credential.

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)

basicAuthIdstring(uuid)required

Unique identifier of the basic auth credential (UUID format)

Response

application/json

List of passwords

ListKongPasswords

metaobjectrequired
Show Child Parameters
dataarray[object]required

A password credential associated with a basic auth entry. The password value is not returned after creation.

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

Create a password for a basic auth credential

Creates a new password for the specified basic auth credential.
The password value is only returned on creation and cannot be retrieved again.

post

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

Password to be created

CreatePasswordBody

secretstring

>= 1 characters<= 255 characters

expires_atstring | null(date-time)

An ISO-8601 timestamp representation of entity expiration date.

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

Response

application/json

A password with its secret value, returned only on creation

KongPasswordWithSecret

A password credential with the secret value. The secret is only returned when the password is first created
and cannot be retrieved again later.

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

secretstringrequired

The password secret value. This is only returned when the password is first created
and cannot be retrieved again later.

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

expires_atstring | null(date-time)required

An ISO-8601 timestamp representation of entity expiration date.

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

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

Body

{}
 
application/json

Delete all passwords for a basic auth

Permanently deletes all passwords associated with the specified basic auth credential.
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}/passwords
 

Get a password

Retrieves a specific password by ID. The password value is not returned.

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)

passwordIdstring(uuid)required

Unique identifier of the password (UUID format)

Response

application/json

A password

KongPassword

A password credential associated with a basic auth entry. The password value is not returned after creation.

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

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

expires_atstring | null(date-time)required

An ISO-8601 timestamp representation of entity expiration date.

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

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