Paramètres de réponse de l’API OAuth

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 1 minute de lecture
  • L’API OAuth 2.0 génère une réponse JSON contenant les paramètres suivants sous forme de paires nom-valeur.

    Tableau 1. Paramètres de réponse de jeton d’accès
    Paramètre de réponse Description
    périmètre Quantité d’accès accordée par le jeton d’accès. Le champ d’application est toujours useraccount, ce qui signifie que le jeton d’accès a les mêmes droits que le compte d’utilisateur qui a autorisé le jeton. Par exemple, si Abel Tuter autorise une application en fournissant des informations d’identification de connexion, le jeton d’accès obtenu accorde au porteur du jeton les mêmes privilèges d’accès qu’Abel Tuter.
    token_type Type de jeton émis par la demande, tel que défini dans la RFC OAuth. Le type de jeton est toujours Bearer, ce qui signifie que toute personne en possession du jeton d’accès peut accéder à une ressource protégée sans fournir de clé cryptographique. Voir RFC6750 pour plus d’informations sur la façon dont OAuth 2.0 utilise les jetons de porteur.
    expires_in Durée de vie du jeton d’accès en secondes.
    refresh_token Valeur de chaîne du jeton d’actualisation.
    access_token Valeur de chaîne du jeton d’accès. Les demandes d’accès effectuées dans le délai d’expiration du jeton d’accès renvoient toujours le jeton d’accès actuel.
    format [Facultatif] Format de sortie de la réponse. Cette valeur est toujours JSON.
    Remarque :
    Si un fournisseur OAuth envoie le corps de la réponse comme « content-type » au lieu de « Content-Type », le client HTTP OAuth peut ne pas analyser correctement la réponse. Pour corriger ce problème, créez une propriété système à l’aide de ces paramètres.
    Champ Valeur
    Nom glide.oauth.inhouse.httpclient.enabled
    Type true|false
    Valeur faux

    Pour en savoir plus sur la création de propriétés système, reportez-vous à la rubrique Ajouter une propriété système

    L’exemple suivant illustre la chaîne JSON renvoyée par une demande de jeton d’accès. (Des espaces ont été ajoutés pour améliorer la lisibilité).

    
    {"scope":"useraccount","token_type":"Bearer","expires_in":1800,
    "refresh_token":"w599voG89897rGVDmdp12WA681r9E5948c1CJTPi8g4HGc4NWaz62k6k1K0FMxHW40H8yOO3Hoe",
    "access_token":"F0jh9korTyzd9kaZqZ0SzjKZuS3ut0i4P46Lc52m2JYHiLIcqzFAumpyxshU9mMQ13gJHtxD2fy"}