Update an auth server
Update an auth server.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
Auth server to be updated
The name of the auth server
>= 1 characters
The description of the auth server
The recipients that the tokens are intended for. This becomes the ‘aud’ claim in an access token
>= 1 characters
Algorithm used in the key signing process
Allowed values:RS256RS384RS512PS256PS384PS512
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"}
A trusted origin for the auth server
<= 16 characters
Example:https://example.com
The default access token duration, in seconds, applied to DCR clients registered against this auth server
>= 60<= 2592000
Response
application/json
Response
An auth server
AuthServer
The ID of the auth server
The name of the auth server
>= 1 characters
The description of the auth server
The recipients that the tokens are intended for. This becomes the ‘aud’ claim in an access token
>= 1 characters
Algorithm used in the key signing process
Allowed values:RS256RS384RS512PS256PS384PS512
Default:RS256
The complete URL for the custom authorization server. This becomes the ‘iss’ claim in an access token.
The URI of the metadata document for the auth server
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"}
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
A trusted origin for the auth server
<= 16 characters
Example:https://example.com
The default access token duration, in seconds, applied to DCR clients registered against this auth server
Default:300
>= 60<= 2592000
Authentication
Path Parameters
Body
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.
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 clients returned in the response.
Show Child Parameters
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
List of clients
ClientList
Show Child Parameters
returns the pagination information
Show Child Parameters
Authentication
Path Parameters
Query Parameters
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.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
Client to be created
The name 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
The duration of the minted refresh token is valid for, in seconds
Default:2592000
>= 60<= 157680000
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"}
Requested authentication method for OAuth 2.0 endpoints.
Allowed values:client_secret_postnone
Default:client_secret_post
Response
application/json
Response
A client with a secret
CreatedClient
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
The duration of the minted refresh token is valid for, in seconds
Default:2592000
>= 60<= 157680000
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
The OAuth 2.0 client secret
Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae
Authentication
Path Parameters
Body
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
The duration of the minted refresh token is valid for, in seconds
Default:2592000
>= 60<= 157680000
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