Auth Server Clients

List all client secrets

Changed on

List all the client secrets for a given client.

get/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.

Query parameters

page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]integer
Example:1

Determines which page of the entities to retrieve.

sortstring

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

Example:created_at desc

Sorts a collection of secrets. Supported sort attributes are:

  • created_at
  • updated_at
enabledboolean

Filter by a boolean value (true/false).

Filter secrets returned in the response.

Response

List of client Secrets

Example response

{
  "data": [
    {
      "secret": "YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae",
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes