GlideOAuthClientRequest : champ d’application, global

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 2 minutes de lecture

    • L’API GlideOAuthClientRequest fournit des méthodes de gestion des demandes client OAuth.

    Vous pouvez utiliser cette API dans des scripts globaux et inclus dans le champ d’application. Dans les scripts inclus dans le champ d’application, utilisez l’identificateur d’espace de noms sn_auth.

    GlideOAuthClientRequest : getGrantType()

    Récupère le type d’accord.

    Tableau 1. Paramètres
    Nom Type Description
    aucun
    Tableau 2. Renvoie
    Type Description
    Chaîne Type d’accord.

    GlideOAuthClientRequest : getHeader(nom de chaîne)

    Récupère les en-têtes HTTP pour la chaîne que vous fournissez.

    Tableau 3. Paramètres
    Nom Type Description
    nom Chaîne Nom du paramètre.
    Tableau 4. Renvoie
    Type Description
    Mapchaîne de caractères Mappage de chaîne avec les en-têtes HTTP.

    GlideOAuthClientRequest : getHeaders()

    Récupère les en-têtes HTTP.

    Tableau 5. Paramètres
    Nom Type Description
    aucun
    Tableau 6. Renvoie
    Type Description
    Mapchaîne de caractères Mappage de chaîne avec les en-têtes HTTP.

    GlideOAuthClientRequest : getParameter(nom de chaîne)

    Récupère les paramètres du nom de paramètre que vous fournissez.

    Tableau 7. Paramètres
    Nom Type Description
    nom Chaîne Nom du paramètre pour lequel vous souhaitez obtenir les paramètres.
    Tableau 8. Renvoie
    Type Description
    Chaîne Les paramètres.

    GlideOAuthClientRequest : getPassword()

    Récupère le mot de passe.

    Tableau 9. Paramètres
    Nom Type Description
    aucun
    Tableau 10. Renvoie
    Type Description
    Chaîne Le mot de passe.

    GlideOAuthClientRequest : getRefreshToken()

    Récupère le jeton d’actualisation.

    Tableau 11. Paramètres
    Nom Type Description
    aucun
    Tableau 12. Renvoie
    Type Description
    Chaîne Le jeton d’actualisation.

    GlideOAuthClientRequest : getScope()

    Récupère le périmètre.

    Tableau 13. Paramètres
    Nom Type Description
    aucun
    Tableau 14. Renvoie
    Type Description
    Chaîne Le champ d’application.

    GlideOAuthClientRequest : getUserName()

    Récupère le nom d’utilisateur.

    Tableau 15. Paramètres
    Nom Type Description
    aucun
    Tableau 16. Renvoie
    Type Description
    Chaîne Le nom d’utilisateur.

    GlideOAuthClientRequest : setGrantType(String grantType)

    Définit le type d’accord pour la chaîne que vous fournissez.

    Remarque :
    Vous n’avez besoin de définir le type d’accord que s’il n’est pas déjà défini dans le profil du fournisseur OAuth.
    Tableau 17. Paramètres
    Nom Type Description
    nom Chaîne Type d’accord.
    Tableau 18. Renvoie
    Type Description
    nul

    GlideOAuthClientRequest : setHead(nom de chaîne, valeur de chaîne)

    Récupère les en-têtes HTTP pour la chaîne que vous fournissez.

    Tableau 19. Paramètres
    Nom Type Description
    nom Chaîne Nom du paramètre.
    valide Chaîne Valeur du paramètre.
    Tableau 20. Renvoie
    Type Description
    nul

    GlideOAuthClientRequest : setParameter(nom de chaîne, valeur de chaîne)

    Définit les paramètres de la paire de chaînes nom-valeur que vous fournissez.

    Tableau 21. Paramètres
    Nom Type Description
    nom Chaîne Nom du paramètre pour lequel vous souhaitez obtenir les paramètres.
    valide Chaîne Valeur du paramètre.
    Tableau 22. Renvoie
    Type Description
    nul

    GlideOAuthClientRequest : setPassword(Mot de passe de chaîne)

    Définit le mot de passe avec la chaîne que vous fournissez.

    Tableau 23. Paramètres
    Nom Type Description
    mot de passe Chaîne Le nom d’utilisateur.
    Tableau 24. Renvoie
    Type Description
    nul

    GlideOAuthClientRequest : setRefreshToken(String refreshToken)

    Définit le jeton d’actualisation avec la chaîne que vous fournissez.

    Tableau 25. Paramètres
    Nom Type Description
    jeton d’actualisation Chaîne Le jeton d’actualisation.
    Tableau 26. Renvoie
    Type Description
    nul

    Cet exemple montre une demande de type d’attribution de mot de passe de propriétaire de ressource.

    
     var tokenRequest =new GlideOAuthClientRequest();
     tokenRequest.setGrantType("password");
     tokenRequest.setUserName("itil");
     tokenRequest.setPassword("itil");
     tokenRequest.setScope(null);
 
     var oAuthClient =new GlideOAuthClient();var tokenResponse = oAuthClient.requestToken("TestClient", tokenRequest);
     gs.log("Error:"+ tokenResponse.getErrorMessage());
 
     var token = tokenResponse.getToken();if(token){
       gs.log("AccessToken:"+ token.getAccessToken());
       gs.log("AccessTokenExpiresIn:"+ token.getExpiresIn());
       gs.log("RefreshToken:"+ token.getRefreshToken());

    Cet exemple montre une demande de type d’attribution de jeton d’actualisation.

    
     var tokenRequest =new GlideOAuthClientRequest();
     tokenRequest.setGrantType("refresh_token");
     tokenRequest.setRefreshToken("N-GtdSVLkWP_Cr-TysXdmNy59ZYafu5ZzAS4YaSluXDm0kCkInEnu-hwM5SsGYSFwKJ6xauVmoaq7xJNoalXFQ");
     tokenRequest.setScope(null);
 
     var oAuthClient =new GlideOAuthClient();
     tokenResponse = oAuthClient.requestToken("TestClient", tokenRequest);
     gs.log("Error:"+ tokenResponse.getErrorMessage());
     token = tokenResponse.getToken();if( token){
        gs.log("AccessToken:"+ token.getAccessToken());
        gs.log("AccessTokenExpiresIn:"+ token.getExpiresIn());
        gs.log("AccessTokenSysID:"+ token.getAccessTokenSysID());
        gs.log("RefreshToken:"+ token.getRefreshToken());
        gs.log("RefreshTokenSysID:"+ token.getRefreshTokenSysID());

    GlideOAuthClientRequest : setScope(champ d’application de chaîne)

    Définit le champ d’application de la chaîne que vous fournissez.

    Remarque :
    Vous n’avez besoin de définir le périmètre que s’il n’est pas déjà défini dans le fournisseur OAuth.
    Tableau 27. Paramètres
    Nom Type Description
    périmètre Chaîne Le champ d’application.
    Tableau 28. Renvoie
    Type Description
    nul

    GlideOAuthClientRequest : setUserName(String userName)

    Définit le nom d’utilisateur avec la chaîne que vous fournissez.

    Tableau 29. Paramètres
    Nom Type Description
    userName Chaîne Le nom d’utilisateur.
    Tableau 30. Renvoie
    Type Description
    nul