Create a new client in the auth server
Create a new client in the auth server
Body
application/json
Body
Client to be created
CreateDCRClientPayload
name of the client
Type of the application
Allowed values:machine
OAuth 2.0 grant type
Requested authentication method for OAuth 2.0 endpoints.
Allowed values:client_secret_postnone
OAUTH 2.0 response type
Allowed values:codeid_tokentoken
Array of redirection URI strings for use in redirect-based flows
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"}
Response
application/json
Response
client
DCRClient
The OAuth 2.0 client ID
Example:kYa9iQFU5xPDSIUH9z1z
unix-epoch time when the client got issued
name of the client
secret of the client. This will be set only at client creation.
unix-epoch time when the secret expires. If = 0 it never expires.
Type of the application
Allowed values:machine
OAuth 2.0 grant type
Requested authentication method for OAuth 2.0 endpoints.
Allowed values:client_secret_postnone
OAUTH 2.0 response type
Allowed values:codeid_tokentoken
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"}
Array of redirection URI strings for use in redirect-based flows
Authentication
Body
Get a client for given auth server
Get a client for given auth server
Path Parameters
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
Response
application/json
Response
client
DCRClient
The OAuth 2.0 client ID
Example:kYa9iQFU5xPDSIUH9z1z
unix-epoch time when the client got issued
name of the client
secret of the client. This will be set only at client creation.
unix-epoch time when the secret expires. If = 0 it never expires.
Type of the application
Allowed values:machine
OAuth 2.0 grant type
Requested authentication method for OAuth 2.0 endpoints.
Allowed values:client_secret_postnone
OAUTH 2.0 response type
Allowed values:codeid_tokentoken
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"}
Array of redirection URI strings for use in redirect-based flows
Authentication
Path Parameters
Replace a client
Replace a client
Path Parameters
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
Body
application/json
Body
Client to be created
CreateDCRClientPayload
name of the client
Type of the application
Allowed values:machine
OAuth 2.0 grant type
Requested authentication method for OAuth 2.0 endpoints.
Allowed values:client_secret_postnone
OAUTH 2.0 response type
Allowed values:codeid_tokentoken
Array of redirection URI strings for use in redirect-based flows
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"}
Response
application/json
Response
client
DCRClient
The OAuth 2.0 client ID
Example:kYa9iQFU5xPDSIUH9z1z
unix-epoch time when the client got issued
name of the client
secret of the client. This will be set only at client creation.
unix-epoch time when the secret expires. If = 0 it never expires.
Type of the application
Allowed values:machine
OAuth 2.0 grant type
Requested authentication method for OAuth 2.0 endpoints.
Allowed values:client_secret_postnone
OAUTH 2.0 response type
Allowed values:codeid_tokentoken
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"}
Array of redirection URI strings for use in redirect-based flows
Authentication
Path Parameters
Body
Delete a client for a given auth server
Delete a client for a given auth server
Path Parameters
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
Response
Response
Success
Authentication
Path Parameters
List client secrets
List all secrets for a given client.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
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
Filter secrets returned in the response.
Show Child Parameters
Path Parameters
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
Response
application/json
Response
List of client Secrets
ClientSecretList
The client secret. The secret value is only returned when creating a new secret item.
Show Child Parameters
returns the pagination information