Client

object
idstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

namestringrequired

The name of the client

>= 1 characters

grant_typesarray[string]requiredunique-items

OAuth 2.0 grant type

Allowed values:authorization_codeimplicitclient_credentialsrefresh_token

redirect_urisarray[string](uri)required

The URIs that the client is allowed to redirect to after authentication in interactive flows. All redirect URIs must be absolute URIs, be secure (HTTPS), and must not include a fragment component.

login_uristring(uri)

The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).

access_token_durationintegerrequired

The duration of the minted token is valid for, in seconds

Default:300

>= 60<= 2592000

id_token_durationintegerrequired

The duration of the minted token is valid for, in seconds

Default:300

>= 60<= 2592000

refresh_token_durationintegerrequired

The duration of the minted refresh token is valid for, in seconds

Default:2592000

>= 60<= 157680000

allow_all_scopesbooleanrequired

Specifies whether the client is allowed to request all scopes

Default:false

allow_scopesarray[string](uuid)requiredunique-items

Specifies the scopes IDs that the client is allowed to request

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

response_typesarray[string]required

OAuth 2.0 response type

Allowed values:nonetokencodeid_token

token_endpoint_auth_methodstring

Requested authentication method for OAuth 2.0 endpoints.

Allowed values:client_secret_postnone

Default:client_secret_post

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

Example

CreatedClient

idstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

namestringrequired

The name of the client

>= 1 characters

grant_typesarray[string]requiredunique-items

OAuth 2.0 grant type

Allowed values:authorization_codeimplicitclient_credentialsrefresh_token

redirect_urisarray[string](uri)required

The URIs that the client is allowed to redirect to after authentication in interactive flows. All redirect URIs must be absolute URIs, be secure (HTTPS), and must not include a fragment component.

login_uristring(uri)

The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).

access_token_durationintegerrequired

The duration of the minted token is valid for, in seconds

Default:300

>= 60<= 2592000

id_token_durationintegerrequired

The duration of the minted token is valid for, in seconds

Default:300

>= 60<= 2592000

refresh_token_durationintegerrequired

The duration of the minted refresh token is valid for, in seconds

Default:2592000

>= 60<= 157680000

allow_all_scopesbooleanrequired

Specifies whether the client is allowed to request all scopes

Default:false

allow_scopesarray[string](uuid)requiredunique-items

Specifies the scopes IDs that the client is allowed to request

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

response_typesarray[string]required

OAuth 2.0 response type

Allowed values:nonetokencodeid_token

token_endpoint_auth_methodstring

Requested authentication method for OAuth 2.0 endpoints.

Allowed values:client_secret_postnone

Default:client_secret_post

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

client_secretstringrequired

The OAuth 2.0 client secret

Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae

Example

RefreshedSecret

The result of a refreshed client secret.

secretstringrequired

The OAuth 2.0 client secret

Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae

Example

ClientSecret

string

The OAuth 2.0 client secret

Example

ClientList

object
dataarray[object]required
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
Example