List all clients the auth server

List all clients for the auth server

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[number]integer

Determines which page of the entities to retrieve.

Example:1

Response

200 application/json

List of clients

DCRClientList

dataarray[object]required
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/clients
 
200 application/json

Create a new client in the auth server

Create a new client in the auth server

post

Body

application/json

Client to be created

CreateDCRClientPayload

client_namestringrequired

name of the client

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

redirect_urisarray[string]required

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

labelsobject

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

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

Body

{ "client_name": "kYa9iQFU5xPDSIUH9z1z", "application_type": "machine", "grant_types": [ "client_credentials" ], "token_endpoint_auth_method": "client_secret_post", "response_types": [ "code" ], "redirect_uris": [ "https://mycompany.com/" ] }
 
application/json

Get a client for given auth server

Get a client for given auth server

get

Path Parameters

clientIdstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

Response

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

get/clients/{clientId}
 
application/json

Replace a client

Replace a client

put

Path Parameters

clientIdstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

Body

application/json

Client to be created

CreateDCRClientPayload

client_namestringrequired

name of the client

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

redirect_urisarray[string]required

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

labelsobject

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

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

put/clients/{clientId}

Body

{ "client_name": "kYa9iQFU5xPDSIUH9z1z", "application_type": "machine", "grant_types": [ "client_credentials" ], "token_endpoint_auth_method": "client_secret_post", "response_types": [ "code" ], "redirect_uris": [ "https://mycompany.com/" ] }
 
application/json

Delete a client for a given auth server

Delete a client for a given auth server

delete

Path Parameters

clientIdstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

Response

Success

delete/clients/{clientId}