List all auth servers
List all available auth servers.
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 auth servers returned in the response.
Show Child Parameters
Response
200 application/json
Response
List of auth servers
AuthServerList
Show Child Parameters
returns the pagination information
Show Child Parameters
Authentication
Query Parameters
Create a new auth server
Create a new auth server. Each auth server has a unique, randomly generated, public issuer URL.
Body
application/json
Body
Auth server to be created
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
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"}
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
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
Body
List auth servers with computed attributes
List all the auth servers with computed attributes.
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 auth servers returned in the response.
Show Child Parameters
Response
200 application/json
Response
List of auth servers with computed fields
AuthServerComputedList
Show Child Parameters
returns the pagination information
Show Child Parameters
Authentication
Query Parameters
Get an auth server
Get an auth server.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
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
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