GlideOAuthClientRequest – Scoped, Global

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 2 Minuten Lesedauer
  • Die GlideOAuthClientRequest- API bietet Methoden für die Verarbeitung von OAuth-Client-Anforderungen.

    Sie können diese API in globalen und bereichsbezogenen Skripts verwenden. Verwenden Sie in bereichsbezogenen Skripts den Namespace-Bezeichner sn_auth.

    GlideOAuthClientRequest – getGrantType()

    Ruft den Gewährungstyp ab.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Gewährungstyp.

    GlideOAuthClientRequest – getHeader(String name)

    Ruft die HTTP-Kopfzeilen für die von Ihnen angegebene Zeichenfolge ab.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Der Name des Parameters.
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    StringMap Zeichenfolgenzuordnung mit den HTTP-Headern.

    GlideOAuthClientRequest – getHeaders()

    Ruft die HTTP-Kopfzeilen ab.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    StringMap Zeichenfolgenzuordnung mit den HTTP-Headern.

    GlideOAuthClientRequest – getParameter(String name)

    Ruft die Parameter für den von Ihnen angegebenen Parameternamen ab.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Parametername, für den Sie die Parameter benötigen.
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Parameter.

    GlideOAuthClientRequest – getPassword()

    Ruft das Passwort ab.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Das Passwort.

    GlideOAuthClientRequest – getRefreshToken()

    Ruft das Aktualisierungstoken ab.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Aktualisierungstoken.

    GlideOAuthClientRequest – getScope()

    Ruft den Bereich ab.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Bereich.

    GlideOAuthClientRequest – getUserName()

    Ruft den Benutzernamen ab.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 16. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Benutzername.

    GlideOAuthClientRequest – setGrantType(String grantType)

    Legt den Gewährungstyp für die von Ihnen angegebene Zeichenfolge fest.

    Hinweis:
    Sie müssen den Gewährungstyp nur festlegen, wenn er nicht bereits im OAuth-Provider-Profil definiert ist.
    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Gewährungstyp.
    Tabelle : 18. Ergebnisse
    Typ Beschreibung
    void

    GlideOAuthClientRequest – setHead(String name, String value)

    Ruft die HTTP-Kopfzeilen für die von Ihnen angegebene Zeichenfolge ab.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Der Name des Parameters.
    Wert Zeichenfolge Wert des Parameters.
    Tabelle : 20. Ergebnisse
    Typ Beschreibung
    void

    GlideOAuthClientRequest – setParameter(String name, String value)

    Legt die Parameter für das Name/Wert-Paar der von Ihnen angegebenen Zeichenfolgen fest.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    Name Zeichenfolge Parametername, für den Sie die Parameter benötigen.
    Wert Zeichenfolge Wert des Parameters.
    Tabelle : 22. Ergebnisse
    Typ Beschreibung
    void

    GlideOAuthClientRequest – setPassword(String password)

    Legt das Passwort mit der von Ihnen angegebenen Zeichenfolge fest.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    Passwort Zeichenfolge Benutzername.
    Tabelle : 24. Ergebnisse
    Typ Beschreibung
    void

    GlideOAuthClientRequest – setRefreshToken(String refreshToken)

    Legt das Aktualisierungstoken mit der von Ihnen angegebenen Zeichenfolge fest.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    refreshToken Zeichenfolge Aktualisierungstoken.
    Tabelle : 26. Ergebnisse
    Typ Beschreibung
    void

    In diesem Beispiel wird eine Anforderung für den Gewährungstyp des Ressourcenbesitzerpassworts angezeigt.

    
         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());
    

    In diesem Beispiel wird eine Anforderung für den Gewährungstyp des Aktualisierungstokens angezeigt.

    
         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(String scope)

    Legt den Bereich für die von Ihnen angegebene Zeichenfolge fest.

    Hinweis:
    Sie müssen den Bereich nur festlegen, wenn er nicht bereits im OAuth-Provider definiert ist.
    Tabelle : 27. Parameter
    Name Typ Beschreibung
    scope Zeichenfolge Bereich.
    Tabelle : 28. Ergebnisse
    Typ Beschreibung
    void

    GlideOAuthClientRequest – setUserName(String userName)

    Legt den Benutzernamen mit der von Ihnen angegebenen Zeichenfolge fest.

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    userName Zeichenfolge Benutzername.
    Tabelle : 30. Ergebnisse
    Typ Beschreibung
    void