For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

Start a device authorization request

RFC 8628 device authorization endpoint. Initiates the device flow and returns a device_code, user_code, and verification URIs for the user to approve out of band, then poll the token endpoint. When offline_access is requested, openid is also required.

post/v1/auth/device-authorization

Body

application/json
scopestring

Space-delimited OAuth scopes to request. When offline_access is requested, openid is also required.

Body

application/x-www-form-urlencoded
scopestring

Space-delimited OAuth scopes to request. When offline_access is requested, openid is also required.

Response

application/json
200· Device authorization started.
device_codestringrequired
user_codestringrequired
verification_uristringrequired
expires_inintegerrequired
Other properties2
verification_uri_completestring
intervalinteger
400· Invalid request (RFC 6749 §5.2 OAuth error).
errorstringrequired
Other properties3
error_descriptionstring
error_hintstring
error_uristring
401· Client authentication failed (RFC 6749 §5.2 OAuth error).
errorstringrequired
Other properties3
error_descriptionstring
error_hintstring
error_uristring
500· Server error (RFC 6749 §5.2 OAuth error).
errorstringrequired
Other properties3
error_descriptionstring
error_hintstring
error_uristring

Was this helpful?