Auth Server Clients

Create a new client secret

Changed on

Create a new client secret for a given client. Multiple secrets can be active simultaneously for a single client.

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

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

secretstring

The OAuth 2.0 client secret

enabledboolean

Specifies whether the secret is enabled. If the secret is not enabled, it will not be usable during authentication phase.

Example request

{
  "secret": "YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae"
}

Response

A Client Secret item

idstring uuid required

The ID of the client secret

enabledboolean required

Specifies whether the secret is enabled. If the secret is not enabled, it will not be usable during authentication phase.

secretstring

The OAuth 2.0 client secret

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

{
  "secret": "YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes