Replace an auth server client

Replace a client for a given auth server. The client ID and secret can be provided to update an existing client, or to create a client with the matching ID and secret.

put

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 replaced

namestringrequired

The name of the client

>= 1 characters

client_secretstringrequired

Secret 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

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

token_endpoint_auth_methodstring

Requested authentication method for OAuth 2.0 endpoints.

Allowed values:client_secret_postnone

Default:client_secret_post

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

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

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

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

Body

{ "name": "Replace Client", "client_secret": "SecretPassword", "grant_types": [ "client_credentials" ], "response_types": [ "token" ] }
 
application/json

Delete an auth server client

Delete a client for a given auth server. All tokens associated with the client will also be deleted. This action is irreversible.

delete

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

Success

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

Test a claim template for a client

Test a claim template for a client. Utility function to test claim templates against a client and verify the resulting claim values.

post

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

Claim to be tested

object

A mapstring of the claims and templates

Response

application/json

Result of a claim test

TestClaimResult

TestClaimResultobject

A mapany of the claim that have been templated

post/auth-servers/{authServerId}/clients/{clientId}/test-claim

Body

{ "destination": "anywhere", "uuidv4": "${ uuidv4 }" }
 
application/json

List all auth server client tokens

List all the tokens for a given client.

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 tokens returned in the response.

Show Child Parameters

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

List of tokens

TokenList

dataarray[object]required
Show Child Parameters
metaobjectrequired

returns the pagination information

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

Delete all auth server client tokens

Revoke all tokens for a given client. Revoked tokens can no longer be used to access resources when introspection is enabled on the client.

delete

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

Success

delete/auth-servers/{authServerId}/clients/{clientId}/tokens