Device Poll

Poll for device code approval. Returns a JWT when approved.

POST /auth/device-poll

Device Poll

cURL

curl --request POST \
  --url https://api.hyperspell.com/auth/device-poll \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-As-User: <api-key>' \
  --data '
{
  "device_code": "<string>"
}
'

200

{
  "status": "<string>",
  "token": "<string>",
  "user_key": "<string>",
  "email": "<string>"
}

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

device_code · string · required

Response

200

application/json

Successful Response

status · string · required

token · string | null

user_key · string | null

email · string | null