List all auth servers

List all available auth servers.

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

Show Child Parameters

Response

200 application/json

List of auth servers

AuthServerList

dataarray[object]required
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/auth-servers
 
200 application/json

Create a new auth server

Create a new auth server. Each auth server has a unique, randomly generated, public issuer URL.

post

Body

application/json

Auth server to be created

namestringrequired

The name of the auth server

>= 1 characters

descriptionstring

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_algorithmstring

Algorithm used in the key signing process

Allowed values:RS256RS384RS512PS256PS384PS512

Default:RS256

labelsobject

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

trusted_originsarray[string](uri)unique-items

A trusted origin for the auth server

<= 16 characters

Example:https://example.com

dcr_default_access_token_durationinteger

The default access token duration, in seconds, applied to DCR clients registered against this auth server

Default:300

>= 60<= 2592000

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

dcr_default_access_token_durationinteger

The default access token duration, in seconds, applied to DCR clients registered against this auth server

Default:300

>= 60<= 2592000

post/auth-servers

Body

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

List auth servers with computed attributes

List all the auth servers with computed attributes.

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

Show Child Parameters

Response

200 application/json

List of auth servers with computed fields

AuthServerComputedList

dataarrayrequired
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/auth-servers/_computed
 
200 application/json

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

dcr_default_access_token_durationinteger

The default access token duration, in seconds, applied to DCR clients registered against this auth server

Default:300

>= 60<= 2592000

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

dcr_default_access_token_durationinteger

The default access token duration, in seconds, applied to DCR clients registered against this auth server

>= 60<= 2592000

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

dcr_default_access_token_durationinteger

The default access token duration, in seconds, applied to DCR clients registered against this auth server

Default:300

>= 60<= 2592000

patch/auth-servers/{authServerId}

Body

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