Skip to main content
POST
Create Device Auth Session

Body

application/json
client_name
string
required

Client requesting access.

Required string length: 1 - 64
Pattern: ^[^\x00-\x1f\x7f-\x9f]*$
client_version
string
required

Client version.

Required string length: 1 - 64
Pattern: ^[^\x00-\x1f\x7f-\x9f]*$
hostname
string | null

Machine requesting access.

Maximum string length: 255
Pattern: ^[^\x00-\x1f\x7f-\x9f]*$
platform
string | null

Operating system and architecture, such as darwin-arm64.

Maximum string length: 64
Pattern: ^[^\x00-\x1f\x7f-\x9f]*$

Response

Successful Response

device_code
string
required

Secret the device polls with. Only the device ever sees it; never display it.

user_code
string
required

Code shown in the terminal and the browser so the user can match them.

verification_url
string
required

Platform page where the user approves the device.

expires_at
string<date-time>
required

UTC time after which the session cannot be used.

poll_interval_seconds
integer
required

Minimum seconds between token polls.