Skip to main content

Methods

Start device authorization
TypeScript
POST /v1/auth/device/codeExchange device code or refresh token
TypeScript
POST /v1/auth/device/token

Models

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.

DeviceTokenResponse

string
required
Bearer access token for authenticated Photon API requests.
string
Authentication method used for the device login, when returned. Omitted for refresh grants.
number
required
Access-token validity in seconds, derived from its expiry and issue times; defaults to 300 when unavailable.
string
required
Refresh token for the next refresh grant. Tokens rotate on every grant; replace the stored value with this one.
DeviceTokenResponseUser
required
Profile of the authenticated user.