Starts a sign-in for a program, to be approved from a browser.

POST

/api/v1/auth/device

400 when the name is empty or too long, 404 when this instance has no accounts, 429 when this address has started too many.

Request Body

application/json

Body of POST /auth/device.

client_name*string

What the program calls itself, such as tessera CLI on laptop. Shown on the approval page and used as the token's name.

Started; show the user code and poll with the device code

application/json

A started request, as the program needs it.

device_code*string

The program keeps this and polls with it. Never shown to the person.

expires_in*integer

Seconds until both codes stop working.

Formatint64

Range0 <= value

interval*integer

Seconds to wait between polls.

Formatint64

Range0 <= value

user_code*string

What the person types on the site's /device page.

curl -X POST 'https://example.com/api/v1/auth/device' \  -H 'Content-Type: application/json' \  -d '{  "client_name": "string"}'

{  "device_code": "string",  "expires_in": 0,  "interval": 0,  "user_code": "string"}