Skip to main content
POST
/
auth
/
device-login
Device Login
curl --request POST \
  --url https://api.hyperspell.com/auth/device-login \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-As-User: <api-key>' \
  --data '
{
  "app_slug": "<string>",
  "device_name": "<string>",
  "requester_name": "<string>"
}
'
{
  "device_code": "<string>",
  "login_url": "<string>",
  "poll_interval": 2,
  "expires_in": 600
}

Authorizations

​
Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

​
X-As-User
string
header
required

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Body

application/json
​
app_slug
string
required
​
device_name
string | null
​
requester_name
string | null

Response

Successful Response

​
device_code
string
required
​
login_url
string
required
​
poll_interval
integer
default:2
​
expires_in
integer
default:600