Start an OAuth Device Authorization Grant.

POST

/device_authorization

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/device_authorization \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data client_id=client_123 \
  --data 'scope=openid profile email'

Request Body

Media type application/x-www-form-urlencoded

object

client_id

required

string

scope

string

Example

client_id=client_123&scope=openid+profile+email

Responses

200

Successful JSON response.

Media type application/json

object

device_code

required

string

user_code

required

string

verification_uri

required

string format: uri

verification_uri_complete

required

string format: uri

expires_in

required

integer

interval

required

integer

Example

{
  "device_code": "GmRhmhcxhwAzkoEqiMEg_DnyEysNkuNhszIySk9eS",
  "user_code": "WDJB-MJHT",
  "verification_uri": "https://auth.example.com/device",
  "verification_uri_complete": "https://auth.example.com/device?user_code=WDJB-MJHT&tenant_hint=tenant_123",
  "expires_in": 600,
  "interval": 5
}