Skip to main content
POST /v1/auth/device/code Starts the device authorization flow for a CLI or another device without a browser. Show the verification URL and user code, then poll the token endpoint at the returned interval. No request fields are required; any supplied body is ignored.
TypeScript

Returns

200 Verification details for the RFC 8628 device flow. The optional JSON or form body is ignored; the authorization client is selected by the server. DeviceAuthorizeResponse
string
required
Opaque device code to exchange at POST /v1/auth/device/token while waiting for the user to authorize.
number
required
Lifetime of the device code and user code, in seconds.
number
required
Minimum number of seconds to wait between token polling requests.
string
required
Code the user enters at verification_uri to authorize this device.
string
required
Browser URL where the user enters user_code and authorizes the device.
string
required
Browser URL with user_code included, ready to open or encode as a QR code.