デバイスの認可

入力手段が限られたデバイス向けに、デバイス認可フローを開始するためのデバイスコードを取得します。

​

エンドポイント

POST /oauth/device/code

このフローは、入力手段が限られたデバイスが API にアクセスするために設計されています。ユーザーがデバイスを認可できるようにするデバイスコードを取得するには、このエンドポイントを使用します。

​

リクエスト例

POST https://{yourDomain}/oauth/device/code
Content-Type: application/x-www-form-urlencoded

client_id=${account.clientId}&scope=SCOPE&audience=API_IDENTIFIER

​

レスポンス値

値	説明
device_code	デバイスの一意のコード。
user_code	デバイスを認可するために、ユーザーが入力する必要があるユーザーコード。
verification_uri	デバイスを認可するために、ユーザーがアクセスする URL。
verification_uri_complete	ユーザーコードを含む完全な URL。簡単にアクセスできます。
expires_in	デバイスコードとユーザーコードの有効期間 (秒) 。
interval	トークンをリクエストするためのポーリング間隔 (秒) 。

​

注記

• リフレッシュトークンを取得するには、scope に offline_access を含めます。
• 返されたデバイスコードを使用して、トークンエンドポイントにアクセストークンをリクエストします。

​

トークンリクエストの例

POST https://{yourDomain}/oauth/token
Content-Type: application/x-www-form-urlencoded

client_id=${account.clientId}&device_code=YOUR_DEVICE_CODE&grant_type=urn:ietf:params:oauth:grant-type:device_code

​

レスポンス

​

200

リクエストが成功すると、アクセストークンが返されます。

HTTP/1.1 200 OK
Content-Type: application/json
{
   "access_token": "eyJz93a...k4laUWw",
   "id_token": "eyJ...0NE",
   "refresh_token": "eyJ...MoQ",
   "expires_in": 86400,
   "token_type": "Bearer"
}

​

エラーレスポンス

HTTP/1.1 403 Forbidden
Content-Type: application/json
{ "error": "authorization_pending", "error_description": "User has yet to authorize device code." }

HTTP/1.1 429 Too Many Requests
Content-Type: application/json
{ "error": "slow_down", "error_description": "You are polling faster than the specified interval of 5 seconds." }

HTTP/1.1 403 Forbidden
Content-Type: application/json
{ "error": "access_denied", "error_description": "User cancelled the confirmation prompt." }

​

詳しくはこちら

• デバイス認可フロー
• デバイス認可フローを使用して API を呼び出す
• Management Dashboard でデバイスコードグラントを設定する

​

Body パラメーター

client_id · string · 必須

アプリケーションの ID。

scope · string

認可をリクエストするスコープ。

audience · string

アクセスする対象 API の一意の識別子。

resource · string

アクセスする対象 API (リソースサーバー) の識別子。Auth0 テナントに登録されている API 識別子と一致する必要があります。テナントの Resource Parameter Compatibility Profile が compatibility に設定されている場合は、audience の代わりに使用されます。

​

レスポンススキーマ

​

レスポンスメッセージ

ステータス	説明
200	デバイスコードとユーザーコードが返されます。