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
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
Authentication
Body
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
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
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
Authentication
Path Parameters
Body
Delete an auth server
Delete an auth server. If force=true, delete the auth server and all its associated resources. If force=false, only allow deletion if no resources are associated with the auth server. This action is irreversible.
Query Parameters
If true, delete the specified auth server and all its associated resources. If false, only allow deletion if no clients, scopes or claims are associated with the auth server.
Allowed values:truefalse
Default:false
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
Success
Authentication
Path Parameters
Query Parameters
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.