Auth Server Clients

Update a client secret

Changed on

Update a client secret for a given client, such as enabling or disabling the secret.

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

Request

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

Request body

enabledboolean

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

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

  • f530bf400198Revision changes
    • warning

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

    • warning

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

  • 4a02153f2e60Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status