OAuthUtil : global

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 1 minute de lecture

    • L’include de script OAuthUtil modifie les paramètres de demande et analyse la réponse du jeton pendant l’exécution.

    Si le fournisseur OAuth externe renvoie une réponse autre qu’une réponse de type application/JSON, vous pouvez personnaliser votre propre version de cet include de script pour analyser les réponses qui sont dans un format différent. Étendez ou copiez cet include de script, puis référencez votre version à partir du champ Script de l’API OAuth sur le formulaire Registre d’application pour les fournisseurs OAuth tiers. Le nom de l’include de script personnalisé doit commencer par OAuth.

    Par exemple, si le fournisseur OAuth a besoin d’un paramètre de ressource avec la valeur https://outlook.office365.com, le code ressemblera à ceci : 
    preprocessAccessToken: function(requestParamMap) {
  requestParamMap.put("resource", "https://outlook.office365.com");
},

    OAuthUtil : getOAuthProfile()

    Renvoie un GlideRecord représentant le profil OAuth actuel

    Tableau 1. Paramètres
    Nom Type Description
    Aucun
    Tableau 2. Renvoie
    Type Description
    GlideRecord GlideRecord représentant le profil OAuth actuel

    OAuthUtil : interceptRequestParameters(requestParamMap)

    Ajoute une paire nom-valeur aux paramètres de la demande.

    Tableau 3. Paramètres
    Nom Type Description
    requestParamMap (en anglais seulement) Chaîne La paire nom-valeur que vous souhaitez ajouter.
    Tableau 4. Renvoie
    Type Description
    nul

    OAuthUtil : parseTokenResponse(accessTokenResponse)

    Analyse le jeton reçu dans une carte de paramètres.

    Tableau 5. Paramètres
    Nom Type Description
    accessTokenResponse (en anglais seulement) Chaîne La réponse du jeton d’accès que vous souhaitez analyser.
    Tableau 6. Renvoie
    Type Description
    nul

    OAuthUtil : setEndpoint(url)

    Définir le point de terminaison de votre demande OAuth

    Tableau 7. Paramètres
    Nom Type Description
    URL Chaîne Point de terminaison d’URL pour votre demande
    Tableau 8. Renvoie
    Type Description
    nul

    OAuthUtil : setHeader(headerName, headerValue)

    Ajouter un en-tête à une demande de jeton sortante.

    Tableau 9. Paramètres
    Nom Type Description
    headerName Chaîne Nom de votre en-tête de demande de jeton
    headerValue Chaîne Valeur de votre en-tête de demande de jeton
    Tableau 10. Renvoie
    Type Description
    nul

    OAuthUtil : setQueryParameter(paramName, paramValue)

    Ajouter un paramètre de requête à une demande OAuth.

    Tableau 11. Paramètres
    Nom Type Description
    paramName Chaîne Nom de votre paramètre
    paramValue Chaîne Valeur de votre paramètre
    Tableau 12. Renvoie
    Type Description
    nul