Request Device Code

curl --request POST \
  --url https://{yourDomain}/oauth/device/code \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'client_id=<string>' \
  --data 'scope=openid profile email' \
  --data 'audience=<string>'

{
  "device_code": "GmRhmhcxhwAzkoEqiMEg_DnyEysNkuNhszIySk9eS",
  "user_code": "WDJB-MJHT",
  "verification_uri": "https://your-tenant.auth0.com/activate",
  "verification_uri_complete": "https://your-tenant.auth0.com/activate?user_code=WDJB-MJHT",
  "expires_in": 900,
  "interval": 5
}

Request Device Code

Request a device code and user code for the OAuth 2.0 Device Authorization Flow. This flow is designed for input-constrained devices like smart TVs, IoT devices, or gaming consoles.

How it works:

Device requests a device code from this endpoint
Device displays the user_code and verification_uri to the user
User visits the URL on another device and enters the code
Device polls /oauth/token using the device_code until user completes authorization

POST

https://{yourDomain}

oauth

device

code

Request Device Code

curl --request POST \
  --url https://{yourDomain}/oauth/device/code \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'client_id=<string>' \
  --data 'scope=openid profile email' \
  --data 'audience=<string>'

{
  "device_code": "GmRhmhcxhwAzkoEqiMEg_DnyEysNkuNhszIySk9eS",
  "user_code": "WDJB-MJHT",
  "verification_uri": "https://your-tenant.auth0.com/activate",
  "verification_uri_complete": "https://your-tenant.auth0.com/activate?user_code=WDJB-MJHT",
  "expires_in": 900,
  "interval": 5
}

承認

Authorization

string

header

必須

The access token received from the authorization server in the OAuth 2.0 flow.

ボディ

application/x-www-form-urlencoded

client_id

string

必須

Your application's Client ID

scope

string

Space-delimited list of requested scopes

例:

"openid profile email"

audience

string

The unique identifier of the target API you want to access

レスポンス

Device code issued successfully

device_code

string

必須

The device verification code used when polling for tokens

user_code

string

必須

The end-user verification code. Display this to the user.

verification_uri

string<uri>

必須

The URI the user should visit to enter the user_code

expires_in

integer

必須

The lifetime in seconds of the device_code and user_code

interval

integer

必須

The minimum number of seconds to wait between polling requests to /oauth/token

verification_uri_complete

string<uri>

Optional URI that includes the user_code for easier user experience

Verify

Revoke Refresh Token

⌘I

Documentation Index

承認

ボディ

レスポンス