v1

latestOpenAPI 3.1.02026-08-06173665.4 KB

Create authentication token

Generates an authentication credential token for a private account.

post/v1/clients/{clientId}/auth/credential-tokens

Path parameters

clientIdstring required

Unique identifier for the client.

Request body

client_idstring required
client_secretstring required

Example request

{
  "client_id": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
  "client_secret": "your_client_secret_here"
}

Response

Successfully created credential token.

idstring uuid
client_idstring uuid
client_credential_idstring uuid
tokenstring

JWT authentication token

status'ACTIVE' | 'INACTIVE'
expires_atstring date-time
created_atstring date-time
updated_atstring date-time
deleted_atstring nullable

Example response

{
  "id": "1307f4e3-3960-4b98-9a14-0b6839245cc9",
  "client_id": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
  "client_credential_id": "e981c6d8-4d49-45f2-a7ee-f956dca15500",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWQiOiJjMmQxZDFlMy0zMzQwLTQxNzAtOTgwZS1lOTI2OWJiYmM1NTEiLCJleHAiOjE3NDEyODE0MTl9.ziSqMClLqwUVfyM15bqUF_7-PINY0ZiWkH01s8pO3gA",
  "status": "ACTIVE",
  "expires_at": "2025-03-06T11:16:59.491631-06:00",
  "created_at": "2025-03-05 11:16:59.488685-06:00",
  "updated_at": "2025-03-05 11:16:59.488685-06:00",
  "deleted_at": "None"
}