Authentication

Retrieve client credentials

Changed on

Returns the active credentials associated with a client. Use the client_secret returned here to create a bearer token with POST /v1/clients/{clientId}/auth/credential-tokens.

get/v1/clients/{clientId}/credentials

Request

Path parameters

clientIdstring uuid required
Example:c2d1d1e3-3340-4170-980e-e9269bbbc551

The unique identifier of the client.

Response

A list of client credentials.

Example response

{
  "data": [
    {
      "id": "e981c6d8-4d49-45f2-a7ee-f956dca15500",
      "client_id": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
      "client_secret": "client_secret_value",
      "environment": "staging",
      "status": "ACTIVE",
      "created_at": "2025-03-05T10:27:36.888241-06:00",
      "updated_at": "2025-03-05T10:27:36.888241-06:00",
      "api_key": "api_key_value"
    }
  ]
}

Changes

    • info

      api tag Authentication added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status