GlideOAuthClientRequest - Scoped, Global

  • Release version: Xanadu
  • Updated August 1, 2024
  • 2 minutes to read

    • The GlideOAuthClientRequest API provides methods for handling OAuth client requests.

    You can use this API in global and scoped scripts. In scoped scripts use the sn_auth namespace identifier.

    GlideOAuthClientRequest - getGrantType()

    Retrieves the grant type.

    Table 1. Parameters
    Name Type Description
    none
    Table 2. Returns
    Type Description
    String The grant type.

    GlideOAuthClientRequest - getHeader(String name)

    Retrieves the HTTP headers for the string you provide.

    Table 3. Parameters
    Name Type Description
    name String The name of the parameter.
    Table 4. Returns
    Type Description
    StringMap The string map with the HTTP headers.

    GlideOAuthClientRequest - getHeaders()

    Retrieves the HTTP headers.

    Table 5. Parameters
    Name Type Description
    none
    Table 6. Returns
    Type Description
    StringMap The string map with the HTTP headers.

    GlideOAuthClientRequest - getParameter(String name)

    Retrieves the parameters for the parameter name you provide.

    Table 7. Parameters
    Name Type Description
    name String The parameter name for which you want the parameters.
    Table 8. Returns
    Type Description
    String The parameters.

    GlideOAuthClientRequest - getPassword()

    Retrieves the password.

    Table 9. Parameters
    Name Type Description
    none
    Table 10. Returns
    Type Description
    String The password.

    GlideOAuthClientRequest - getRefreshToken()

    Retrieves the refresh token.

    Table 11. Parameters
    Name Type Description
    none
    Table 12. Returns
    Type Description
    String The refresh token.

    GlideOAuthClientRequest - getScope()

    Retrieves the scope.

    Table 13. Parameters
    Name Type Description
    none
    Table 14. Returns
    Type Description
    String The scope.

    GlideOAuthClientRequest - getUserName()

    Retrieves the user name.

    Table 15. Parameters
    Name Type Description
    none
    Table 16. Returns
    Type Description
    String The user name.

    GlideOAuthClientRequest - setGrantType(String grantType)

    Sets the grant type for the string you provide.

    Note:
    You only need to set the grant type if it is not already defined in the OAuth provider profile.
    Table 17. Parameters
    Name Type Description
    name String The grant type.
    Table 18. Returns
    Type Description
    void

    GlideOAuthClientRequest - setHead(String name, String value)

    Retrieves the HTTP headers for the string you provide.

    Table 19. Parameters
    Name Type Description
    name String The name of the parameter.
    value String The value of the parameter.
    Table 20. Returns
    Type Description
    void

    GlideOAuthClientRequest - setParameter(String name, String value)

    Sets the parameters for the name:value pair of strings you provide.

    Table 21. Parameters
    Name Type Description
    name String The parameter name for which you want the parameters.
    value String The value of the parameter.
    Table 22. Returns
    Type Description
    void

    GlideOAuthClientRequest - setPassword(String password)

    Sets the password with the string you provide.

    Table 23. Parameters
    Name Type Description
    password String The user name.
    Table 24. Returns
    Type Description
    void

    GlideOAuthClientRequest - setRefreshToken(String refreshToken)

    Sets the refresh token with the string you provide.

    Table 25. Parameters
    Name Type Description
    refreshToken String The refresh token.
    Table 26. Returns
    Type Description
    void

    This example shows a resource owner password grant type request.

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

    This example shows a refresh token grant type request.

    
     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)

    Sets the scope for the string you provide.

    Note:
    You only need to set the scope if it is not already defined in the OAuth provider.
    Table 27. Parameters
    Name Type Description
    scope String The scope.
    Table 28. Returns
    Type Description
    void

    GlideOAuthClientRequest - setUserName(String userName)

    Sets the user name with the string you provide.

    Table 29. Parameters
    Name Type Description
    userName String The user name.
    Table 30. Returns
    Type Description
    void