Auth Server Clients

Replace an auth server client

Changed on

Replace a client for a given auth server. The client ID and secret can be provided to update an existing client, or to create a client with the matching ID and secret.

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

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/auth-servers/{authServerId}/clients/{clientId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

namestring required

The name of the client

client_secretstring required

Secret of the client

grant_typesGrantType[] required

List of OAuth 2.0 grant types

response_typesResponseType[] required

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

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

refresh_token_durationinteger

The duration of the minted refresh 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.

labelsLabels

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

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

  • cef0f947e9c9Revision changes
    • warning

      added the new private_key_jwt enum value to the response property for the response status

    • warning

      added the new private_key_jwt enum value to the response property for the response status

    • warning

      added the new urn:ietf:params:oauth:grant-type:jwt-bearer enum value to the / response property for the response status

    • warning

      added the new urn:ietf:params:oauth:grant-type:jwt-bearer enum value to the / response property for the response status

    • info

      added the new private_key_jwt enum value to the request property

    • info

      added the new urn:ietf:params:oauth:grant-type:jwt-bearer enum value to the request property /

  • e425d5193d3eRevision changes
    • warning

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

    • warning

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

    • info

      added the new optional request property

    • info

      added the new refresh_token enum value to the request property /

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status