Sign in
Auth Server Clients

Get an auth server client

Get a client for given auth server.

get/v1/auth-servers/{authServerId}/clients/{clientId}

Response

A client

idstring required

The OAuth 2.0 client ID

namestring required

The name of the client

grant_typesGrantType[] required

List of OAuth 2.0 grant types

redirect_urisstring[] 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 nullable

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_durationinteger required

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

id_token_durationinteger required

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

refresh_token_durationinteger required

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

allow_all_scopesboolean required

Specifies whether the client is allowed to request all scopes

allow_scopesstring[] required

Specifies the scopes IDs that the client is allowed to request

labelsLabels required

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 "_".

response_typesResponseType[] required

List of OAuth 2.0 response types

token_endpoint_auth_method'client_secret_post' | 'none'

Requested authentication method for OAuth 2.0 endpoints.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "kYa9iQFU5xPDSIUH9z1z",
  "labels": {
    "env": "test"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

Changed in 5 of the 29 revisions of this API.115

  • e425d5193d3e11See the full diff
    • ●

      added the new refresh_token enum value to the grant_types/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the required property refresh_token_duration to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 106b373707f31See the full diff
    • ▲

      the response property login_uri became optional for the status 200

      response-property-became-optional

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ecce2daf9de61See the full diff
    • ○

      added the optional property token_endpoint_auth_method to the response with the 200 status

      response-optional-property-added

  • b2800570b3e22See the full diff
    • ○

      api tag Auth Server Clients added

      api-tag-added

    • ○

      api tag authserver removed

      api-tag-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a0a9c5c8afa21See the full diff
    • ○

      endpoint added

      endpoint-added