Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs-staging.auth0-mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

POST /oauth/device/code Ce flux est conçu pour que les appareils à contraintes d’entrée puissent accéder à une API. Ce point de terminaison permet d’obtenir un code d’appareil qui permet à l’utilisateur d’autoriser l’appareil.

Exemple de réponse

POST https://${account.namespace}/oauth/device/code
Content-Type: application/x-www-form-urlencoded

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

Valeurs de réponse

ValeurDescription
device_codeLe code unique de l’appareil.
user_codeCode que l’utilisateur doit saisir pour autoriser l’appareil.
verification_uriURL que l’utilisateur doit visiter pour autoriser l’appareil.
verification_uri_completeL’URL complète, y compris le code d’utilisateur, pour faciliter l’accès.
expires_inLa durée de vie des codes de l’appareil et de l’utilisateur en secondes.
intervalIntervalle d’interrogation en secondes pour demander un jeton.

Remarques

  • Ajoutez offline_access à scope pour obtenir un jeton d’actualisation.
  • Utilisez le code de l’appareil renvoyé pour demander un jeton d’accès au point de terminaison du jeton.

Exemple de demande de jeton

POST https://${account.namespace}/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

Réponses

200

Une demande réussie renvoie un jeton d’accès.
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"
}

Réponses d’erreur

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." }

En savoir plus

Obtenir un jeton avec le code de l’appareil

Il s’agit de l’autorisation OAuth 2.0 permettant aux appareils à contraintes d’entrée d’accéder à une API. Utilisez ce point de terminaison pour demander un jeton d’accès en utilisant le code de l’appareil obtenu précédemment.

Remarques

  • Étant donné que vous interrogerez ce point de terminaison (en utilisant l’interval de la réponse initiale pour déterminer la fréquence) en attendant que l’utilisateur accède à la vérification de l’URL et saisisse son code d’utilisateur, il est probable que vous obteniez au moins un échec avant de recevoir une réponse positive. Voir les exemples de réponses possibles.

En savoir plus

Parameters

client_id
string
L’ID de votre application.
scope
string
Les permissions pour lesquelles vous souhaitez demander une autorisation.
audience
string
L’identifiant unique de l’API cible à laquelle vous souhaitez accéder.

Response

StatusDescription
200Renvoie les codes de l’appareil et de l’utilisateur.