Auth Server Clients

Clients represent the identity of machines, such as microservices, mobile apps, or scripts entity. The management API will give you the ability to create, configure and manage multiple Clients per Auth Server.

List all auth server clients

List all the clients for a given 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

sortstring

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

filterobject

Filter clients returned in the response.

Show Child Parameters

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

List of clients

ClientList

dataarray[object]required
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/auth-servers/{authServerId}/clients
 
application/json

Create a new auth server client

Create a new client for a given auth server. The client ID and secret will be generated automatically. The name attribute must be unique within the auth server. The grant_types and response_types attributes define the OAuth 2.0 and OpenID Connect capabilities of the client.

post

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

Client to be created

namestringrequired

The name of the client

>= 1 characters

grant_typesarray[string]requiredunique-items

OAuth 2.0 grant type

response_typesarray[string]required

OAuth 2.0 response type

redirect_urisarray[string](uri)

The URIs that the client is allowed to redirect to after authentication in interactive flows. All redirect URIs must be absolute URIs, be secure (HTTPS), and must not include a fragment component.

login_uristring | null(uri)

The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).

access_token_durationinteger

The duration of the minted token is valid for, in seconds

Default:300

>= 60<= 2592000

id_token_durationinteger

The duration of the minted token is valid for, in seconds

Default:300

>= 60<= 2592000

refresh_token_durationinteger

The duration of the minted refresh token is valid for, in seconds

Default:2592000

>= 60<= 157680000

allow_all_scopesboolean

Specifies whether the client is allowed to request all scopes

Default:false

allow_scopesarray[string](uuid)unique-items

Specifies the scopes IDs that the client is allowed to request

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"}

token_endpoint_auth_methodstring

Requested authentication method for OAuth 2.0 endpoints.

Allowed values:client_secret_postnone

Default:client_secret_post

Response

application/json

A client with a secret

CreatedClient

idstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

namestringrequired

The name of the client

>= 1 characters

grant_typesarray[string]requiredunique-items

OAuth 2.0 grant type

redirect_urisarray[string](uri)required

The URIs that the client is allowed to redirect to after authentication in interactive flows. All redirect URIs must be absolute URIs, be secure (HTTPS), and must not include a fragment component.

login_uristring | null(uri)

The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).

access_token_durationintegerrequired

The duration of the minted token is valid for, in seconds

Default:300

>= 60<= 2592000

id_token_durationintegerrequired

The duration of the minted token is valid for, in seconds

Default:300

>= 60<= 2592000

refresh_token_durationintegerrequired

The duration of the minted refresh token is valid for, in seconds

Default:2592000

>= 60<= 157680000

allow_all_scopesbooleanrequired

Specifies whether the client is allowed to request all scopes

Default:false

allow_scopesarray[string](uuid)requiredunique-items

Specifies the scopes IDs that the client is allowed to request

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"}

response_typesarray[string]required

OAuth 2.0 response type

token_endpoint_auth_methodstring

Requested authentication method for OAuth 2.0 endpoints.

Allowed values:client_secret_postnone

Default:client_secret_post

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

client_secretstringrequired

The OAuth 2.0 client secret

Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae

post/auth-servers/{authServerId}/clients

Body

{ "name": "Client", "grant_types": [ "client_credentials" ], "allow_all_scopes": false, "allow_scopes": [ "c5e12516-182c-4928-ae04-05374b3b1cca", "b5525b78-f3a0-4bd6-befc-7696be58717e" ], "redirect_uris": [ "https://client.com/callback" ], "access_token_duration": 3600, "id_token_duration": 3600, "refresh_token_duration": 2592000, "response_types": [ "token" ], "token_endpoint_auth_method": "client_secret_post" }
 
application/json

Get an auth server client

Get a client for given auth server.

get

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

clientIdstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

Response

application/json

A client

Client

idstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

namestringrequired

The name of the client

>= 1 characters

grant_typesarray[string]requiredunique-items

OAuth 2.0 grant type

redirect_urisarray[string](uri)required

The URIs that the client is allowed to redirect to after authentication in interactive flows. All redirect URIs must be absolute URIs, be secure (HTTPS), and must not include a fragment component.

login_uristring | null(uri)

The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).

access_token_durationintegerrequired

The duration of the minted token is valid for, in seconds

Default:300

>= 60<= 2592000

id_token_durationintegerrequired

The duration of the minted token is valid for, in seconds

Default:300

>= 60<= 2592000

refresh_token_durationintegerrequired

The duration of the minted refresh token is valid for, in seconds

Default:2592000

>= 60<= 157680000

allow_all_scopesbooleanrequired

Specifies whether the client is allowed to request all scopes

Default:false

allow_scopesarray[string](uuid)requiredunique-items

Specifies the scopes IDs that the client is allowed to request

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"}

response_typesarray[string]required

OAuth 2.0 response type

token_endpoint_auth_methodstring

Requested authentication method for OAuth 2.0 endpoints.

Allowed values:client_secret_postnone

Default:client_secret_post

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/auth-servers/{authServerId}/clients/{clientId}
 
application/json

Update an auth server client

Update a client for a given auth server.

patch

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

clientIdstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

Body

application/json

Client to be updated

namestring

The name of the client

>= 1 characters

client_secretstring

Secret of the client

>= 1 characters

grant_typesarray[string]unique-items

OAuth 2.0 grant type

response_typesarray[string]

OAuth 2.0 response type

redirect_urisarray[string](uri)

The URIs that the client is allowed to redirect to after authentication in interactive flows. All redirect URIs must be absolute URIs, be secure (HTTPS), and must not include a fragment component.

login_uristring | null(uri)

The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).

access_token_durationinteger

The duration of the minted token is valid for, in seconds

>= 60<= 2592000

id_token_durationinteger

The duration of the minted token is valid for, in seconds

>= 60<= 2592000

refresh_token_durationinteger

The duration of the minted refresh token is valid for, in seconds

>= 60<= 157680000

allow_all_scopesboolean

Specifies whether the client is allowed to request all scopes

allow_scopesarray[string](uuid)unique-items

Specifies the scopes IDs that the client is allowed to request

token_endpoint_auth_methodstring

Requested authentication method for OAuth 2.0 endpoints.

Allowed values:client_secret_postnone

Default:client_secret_post

labelsobject | null

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

Labels are intended to store INTERNAL metadata.

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

Example:{"env":"test"}

Response

application/json

A client

Client

idstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

namestringrequired

The name of the client

>= 1 characters

grant_typesarray[string]requiredunique-items

OAuth 2.0 grant type

redirect_urisarray[string](uri)required

The URIs that the client is allowed to redirect to after authentication in interactive flows. All redirect URIs must be absolute URIs, be secure (HTTPS), and must not include a fragment component.

login_uristring | null(uri)

The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).

access_token_durationintegerrequired

The duration of the minted token is valid for, in seconds

Default:300

>= 60<= 2592000

id_token_durationintegerrequired

The duration of the minted token is valid for, in seconds

Default:300

>= 60<= 2592000

refresh_token_durationintegerrequired

The duration of the minted refresh token is valid for, in seconds

Default:2592000

>= 60<= 157680000

allow_all_scopesbooleanrequired

Specifies whether the client is allowed to request all scopes

Default:false

allow_scopesarray[string](uuid)requiredunique-items

Specifies the scopes IDs that the client is allowed to request

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"}

response_typesarray[string]required

OAuth 2.0 response type

token_endpoint_auth_methodstring

Requested authentication method for OAuth 2.0 endpoints.

Allowed values:client_secret_postnone

Default:client_secret_post

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

patch/auth-servers/{authServerId}/clients/{clientId}

Body

{ "name": "Updated Client" }
 
application/json