TrustedOrigin

string

A trusted origin for the auth server

Example

DcrDefaultAccessTokenDuration

integer

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

Default:300

>= 60<= 2592000

UpdateDcrDefaultAccessTokenDuration

integer

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

>= 60<= 2592000

AuthServer

object
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

Example

AuthServerComputed

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

clients_countintegerrequired

The number of clients registered with the auth server

Example:1

claims_countintegerrequired

The number of claims registered with the auth server

Example:1

scopes_countintegerrequired

The number of scopes registered with the auth server

Example:1

Example