Create a client secret

Create a new client secret for a given client. Multiple secrets can be active simultaneously for a single client.

post

Path Parameters

clientIdstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

Body

application/json

Secret to be created

CreateSecretPayload

secretstring

The OAuth 2.0 client secret

Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae

enabledboolean

Specifies whether the secret is enabled. If the secret is not enabled, it will not be usable during authentication phase.

Default:true

Response

application/json

A Client Secret item

ClientSecretItem

The client secret. The secret value is only returned when creating a new secret item.

idstring(uuid)required

The ID of the client secret

enabledbooleanrequired

Specifies whether the secret is enabled. If the secret is not enabled, it will not be usable during authentication phase.

Default:true

secretstring

The OAuth 2.0 client secret

Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae

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/clients/{clientId}/secrets

Body

{}
 
application/json

Get a client secret

Get a specific client secret for a given client.

get

Path Parameters

clientIdstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

clientSecretIdstring(uuid)required

The client secret ID

Example:07d05309-45cc-4b37-92fb-1524846deec3

Response

application/json

A Client Secret item

ClientSecretItem

The client secret. The secret value is only returned when creating a new secret item.

idstring(uuid)required

The ID of the client secret

enabledbooleanrequired

Specifies whether the secret is enabled. If the secret is not enabled, it will not be usable during authentication phase.

Default:true

secretstring

The OAuth 2.0 client secret

Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae

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/clients/{clientId}/secrets/{clientSecretId}
 
application/json

Delete a client secret

Delete a client secret for a given client. This action is irreversible.

delete

Path Parameters

clientIdstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

clientSecretIdstring(uuid)required

The client secret ID

Example:07d05309-45cc-4b37-92fb-1524846deec3

Response

Success

delete/clients/{clientId}/secrets/{clientSecretId}
 

Refresh the secret of a client

Refresh the secret of a client

post

Path Parameters

clientIdstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

Response

200 application/json

client

DCRClient

client_idstringrequiredread-only

The OAuth 2.0 client ID

Example:kYa9iQFU5xPDSIUH9z1z

client_id_issued_atintegerrequiredread-only

unix-epoch time when the client got issued

client_namestringrequired

name of the client

client_secretstring | nullrequiredread-only

secret of the client. This will be set only at client creation.

client_secret_expires_atintegerrequiredread-only

unix-epoch time when the secret expires. If = 0 it never expires.

application_typestringrequired

Type of the application

Allowed values:machine

grant_typesarray[string]requiredunique-items

OAuth 2.0 grant type

token_endpoint_auth_methodstringrequired

Requested authentication method for OAuth 2.0 endpoints.

Allowed values:client_secret_postnone

response_typesarray[string]required

OAUTH 2.0 response type

Allowed values:codeid_tokentoken

labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

redirect_urisarray[string]required

Array of redirection URI strings for use in redirect-based flows

post/clients/{clientId}/lifecycle/new-secret
 
200 application/json

ApplicationType

string

Type of the application

Allowed values:machine