Start CLI device authorization

POST/cli/auth/start

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

client_name*string

CLI client name

Lengthlength <= 120

client_os*string

CLI host operating system

client_version*string

CLI client version

requested_scopes?string

Requested API token scope; omitted or cli:full

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/cli/auth/start" \  -H "Content-Type: application/json" \  -d '{    "client_name": "string",    "client_os": "string",    "client_version": "string"  }'

{  "$schema": "https://example.com/api/v1/schemas/StartCLIAuthOutputBody.json",  "device_code": "string",  "expires_in": 0,  "interval": 0,  "user_code": "string",  "verification_url": "string"}

Start CLI device authorization

Request Body

Response Body

200application/json

400application/problem+json

422application/problem+json

429application/problem+json

500application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`