Get an auth server

Get an auth server.

get

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

An auth server

AuthServer

idstring(uuid)required

The ID of the auth server

namestringrequired

The name of the auth server

>= 1 characters

descriptionstringrequired

The description of the auth server

audiencestringrequired

The recipients that the tokens are intended for. This becomes the ‘aud’ claim in an access token

>= 1 characters

signing_algorithmstringrequired

Algorithm used in the key signing process

Allowed values:RS256RS384RS512PS256PS384PS512

Default:RS256

issuerstringrequired

The complete URL for the custom authorization server. This becomes the ‘iss’ claim in an access token.

metadata_uristring(uri)required

The URI of the metadata document for the auth server

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"}

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

trusted_originsarray[string](uri)unique-items

A trusted origin for the auth server

<= 16 characters

Example:https://example.com

get/auth-servers/{authServerId}
 
application/json

Update an auth server

Update an auth server.

patch

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

Auth server to be updated

namestring

The name of the auth server

>= 1 characters

descriptionstring

The description of the auth server

audiencestring

The recipients that the tokens are intended for. This becomes the ‘aud’ claim in an access token

>= 1 characters

signing_algorithmstring

Algorithm used in the key signing process

Allowed values:RS256RS384RS512PS256PS384PS512

labelsobject | null

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"}

trusted_originsarray[string](uri)unique-items

A trusted origin for the auth server

<= 16 characters

Example:https://example.com

Response

application/json

An auth server

AuthServer

idstring(uuid)required

The ID of the auth server

namestringrequired

The name of the auth server

>= 1 characters

descriptionstringrequired

The description of the auth server

audiencestringrequired

The recipients that the tokens are intended for. This becomes the ‘aud’ claim in an access token

>= 1 characters

signing_algorithmstringrequired

Algorithm used in the key signing process

Allowed values:RS256RS384RS512PS256PS384PS512

Default:RS256

issuerstringrequired

The complete URL for the custom authorization server. This becomes the ‘iss’ claim in an access token.

metadata_uristring(uri)required

The URI of the metadata document for the auth server

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"}

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

trusted_originsarray[string](uri)unique-items

A trusted origin for the auth server

<= 16 characters

Example:https://example.com

patch/auth-servers/{authServerId}

Body

{ "name": "Updated Auth Server", "description": "Updated Auth Server Description", "audience": "api://default" }
 
application/json

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.

delete

Query Parameters

forcestring

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

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

Success

delete/auth-servers/{authServerId}
 

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.

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

Show Child Parameters

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

List of clients

ClientList

dataarray[object]required
Show Child Parameters
metaobjectrequired

returns the pagination information

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