Get an auth server client
Get a client for given auth server.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
Response
application/json
Response
A client
Client
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
The name of the client
>= 1 characters
OAuth 2.0 grant type
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.
The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).
The duration of the minted token is valid for, in seconds
Default:300
>= 60<= 2592000
The duration of the minted token is valid for, in seconds
Default:300
>= 60<= 2592000
Specifies whether the client is allowed to request all scopes
Default:false
Specifies the scopes IDs that the client is allowed to request
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"}
OAuth 2.0 response type
Requested authentication method for OAuth 2.0 endpoints.
Allowed values:client_secret_postnone
Default:client_secret_post
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update an auth server client
Update a client for a given auth server.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
Body
application/json
Body
Client to be updated
The name of the client
>= 1 characters
Secret of the client
>= 1 characters
OAuth 2.0 grant type
OAuth 2.0 response type
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.
The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).
The duration of the minted token is valid for, in seconds
>= 60<= 2592000
The duration of the minted token is valid for, in seconds
>= 60<= 2592000
Specifies whether the client is allowed to request all scopes
Specifies the scopes IDs that the client is allowed to request
Requested authentication method for OAuth 2.0 endpoints.
Allowed values:client_secret_postnone
Default:client_secret_post
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
Response
A client
Client
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
The name of the client
>= 1 characters
OAuth 2.0 grant type
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.
The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).
The duration of the minted token is valid for, in seconds
Default:300
>= 60<= 2592000
The duration of the minted token is valid for, in seconds
Default:300
>= 60<= 2592000
Specifies whether the client is allowed to request all scopes
Default:false
Specifies the scopes IDs that the client is allowed to request
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"}
OAuth 2.0 response type
Requested authentication method for OAuth 2.0 endpoints.
Allowed values:client_secret_postnone
Default:client_secret_post
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
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.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
Body
application/json
Body
Client to be replaced
The name of the client
>= 1 characters
Secret of the client
>= 1 characters
OAuth 2.0 grant type
OAuth 2.0 response type
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.
The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).
The duration of the minted token is valid for, in seconds
Default:300
>= 60<= 2592000
The duration of the minted token is valid for, in seconds
Default:300
>= 60<= 2592000
Specifies whether the client is allowed to request all scopes
Default:false
Specifies the scopes IDs that the client is allowed to request
Requested authentication method for OAuth 2.0 endpoints.
Allowed values:client_secret_postnone
Default:client_secret_post
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
A client
Client
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
The name of the client
>= 1 characters
OAuth 2.0 grant type
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.
The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).
The duration of the minted token is valid for, in seconds
Default:300
>= 60<= 2592000
The duration of the minted token is valid for, in seconds
Default:300
>= 60<= 2592000
Specifies whether the client is allowed to request all scopes
Default:false
Specifies the scopes IDs that the client is allowed to request
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"}
OAuth 2.0 response type
Requested authentication method for OAuth 2.0 endpoints.
Allowed values:client_secret_postnone
Default:client_secret_post
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
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.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
Response
Response
Success
Authentication
Path Parameters
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.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
Body
application/json
Body
Claim to be tested
A mapstring of the claims and templates
Response
application/json
Response
Result of a claim test
TestClaimResult
A mapany of the claim that have been templated