Auth Server Clients

Create a new auth server client

Changed on

Create a new client for a given auth server. The client ID and secret will be generated automatically. The name attribute must be unique within the auth server. The grant_types and response_types attributes define the OAuth 2.0 and OpenID Connect capabilities of the client.

post/v1/auth-servers/{authServerId}/clients

Request

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

Request body

namestring required

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

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

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

Requested authentication method for OAuth 2.0 endpoints.

idstring

The OAuth 2.0 client ID

client_secretstring

Secret of the client - will be used when ID is also set.

Example request

{
  "labels": {
    "env": "test"
  },
  "id": "kYa9iQFU5xPDSIUH9z1z"
}

Response

A client with a secret

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.

client_secretstring

The OAuth 2.0 client secret

Example response

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

Changes

  • cef0f947e9c9Revision changes
    • 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

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

  • 55d91b8ceecdRevision changes
    • breaking

      the response property / became optional for the status