Skip to content

Create API authorisation ​

POST
/v1/clients/{requested_client_id}/authorisations/api

Authorizations​

api_key
Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

requested_client_id*

Client ID

Type
string
Required

Request Body​

application/json
JSON
{
  
"client_id": "19941a73d2b5498caf6894d62bb6c3a4_cln",
  
"label": "WebAuth",
  
"service": "api",
  
"username": "user1",
  
"send_key": true
}

Responses​

Created

application/json
JSON
{
  
"label": "Primary Secret",
  
"client_id": "19941a73d2b5498caf6894d62bb6c3a4_cln",
  
"secret": "s3cr3tK3y",
  
"activated": true,
  
"active_until": "2025-12-31T23:59:59"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​