Auth Server Clients

Update an auth server client

Changed on

Update a client for a given auth server.

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

Request

  • Base URL
    https://global.api.konghq.com
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP bearer
    • or HTTP bearer

Path parameters

authServerIdstring uuid required
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientIdstring required

The OAuth 2.0 client ID

Example:kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID. A client whose client_id is the URL of its Client ID Metadata Document is registered and managed by that document: it is not addressable through these endpoints, and any request that targets it is rejected.

Request body

namestring

The name of the client

client_secretstring

Secret of the client

grant_typesGrantType[]

List of OAuth 2.0 grant types

response_typesResponseType[]

List of OAuth 2.0 response types

redirect_urisstring[]

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

Pre-release Feature This feature is currently in beta and is subject to change.

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

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

id_token_durationinteger

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

allow_all_scopesboolean

Specifies whether the client is allowed to request all scopes

allow_scopesstring[]

Specifies the scopes IDs that the client is allowed to request

token_endpoint_auth_method'private_key_jwt' | 'client_secret_post' | 'none'

Requested authentication method for OAuth 2.0 endpoints.

labelsLabelsUpdate nullable

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 request

{
  "labels": {
    "env": "test"
  }
}

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

Pre-release Feature This feature is currently in beta and is subject to change.

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

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'private_key_jwt' | '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