GlideOAuthClientRequest - com escopo, global

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 3 min. de leitura
  • A API GlideOAuthClientRequest fornece métodos para lidar com solicitações de clientes OAuth.

    Você pode usar esta API em scripts globais e com escopo. Em scripts com escopo, use o identificador de namespace sn_auth.

    GlideOAuthClientRequest – getGrantType()

    Recupera o tipo de concessão.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    nenhum
    Tabela 2. Retornos
    Tipo Descrição
    Cadeia de caracteres O tipo de concessão.

    GlideOAuthClientRequest – getHeader(cadeia de caracteres name)

    Recupera os cabeçalhos HTTP da cadeia de caracteres fornecida.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres O nome do parâmetro.
    Tabela 4. Retornos
    Tipo Descrição
    Mapa de cadeia de caracteres O mapa de cadeia de caracteres com os cabeçalhos HTTP.

    GlideOAuthClientRequest – getHeaders()

    Recupera os cabeçalhos HTTP.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    nenhum
    Tabela 6. Retornos
    Tipo Descrição
    Mapa de cadeia de caracteres O mapa de cadeia de caracteres com os cabeçalhos HTTP.

    GlideOAuthClientRequest – getParameter(cadeia de caracteres name)

    Recupera os parâmetros para o nome do parâmetro fornecido.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres O nome do parâmetro para o qual você deseja os parâmetros.
    Tabela 8. Retornos
    Tipo Descrição
    Cadeia de caracteres Os parâmetros.

    GlideOAuthClientRequest – getPassword()

    Recupera a senha.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    nenhum
    Tabela 10. Retornos
    Tipo Descrição
    Cadeia de caracteres A senha.

    GlideOAuthClientRequest – getRefreshToken()

    Recupera o token de atualização.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    nenhum
    Tabela 12. Retornos
    Tipo Descrição
    Cadeia de caracteres O token de atualização.

    GlideOAuthClientRequest – getScope()

    Recupera o escopo.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    nenhum
    Tabela 14. Retornos
    Tipo Descrição
    Cadeia de caracteres O escopo.

    GlideOAuthClientRequest – getUserName()

    Recupera o nome de usuário.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    nenhum
    Tabela 16. Retornos
    Tipo Descrição
    Cadeia de caracteres O nome de usuário.

    GlideOAuthClientRequest – setGrantType(cadeia de caracteres "grantType")

    Define o tipo de concessão para a cadeia de caracteres fornecida.

    Nota:
    Você só precisa definir o tipo de concessão se ele ainda não estiver definido no perfil do provedor OAuth.
    Tabela 17. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres O tipo de concessão.
    Tabela 18. Retornos
    Tipo Descrição
    vazio

    GlideOAuthClientRequest - setHead(cadeia de caracteres nome, cadeia de caracteres valor)

    Recupera os cabeçalhos HTTP da cadeia de caracteres fornecida.

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres O nome do parâmetro.
    valor Cadeia de caracteres O valor do parâmetro.
    Tabela 20. Retornos
    Tipo Descrição
    vazio

    GlideOAuthClientRequest - setParameter(cadeia de caracteres nome, cadeia de caracteres valor)

    Define os parâmetros para o par de cadeias de caracteres nome:valor fornecido.

    Tabela 21. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres O nome do parâmetro para o qual você deseja os parâmetros.
    valor Cadeia de caracteres O valor do parâmetro.
    Tabela 22. Retornos
    Tipo Descrição
    vazio

    GlideOAuthClientRequest – setPassword(cadeia de caracteres de senha)

    Define a senha com a cadeia de caracteres fornecida.

    Tabela 23. Parâmetros
    Nome Tipo Descrição
    senha Cadeia de caracteres O nome de usuário.
    Tabela 24. Retornos
    Tipo Descrição
    vazio

    GlideOAuthClientRequest – setRefreshToken(cadeia de caracteres refreshToken)

    Define o token de atualização com a cadeia de caracteres fornecida.

    Tabela 25. Parâmetros
    Nome Tipo Descrição
    atualizarToken Cadeia de caracteres O token de atualização.
    Tabela 26. Retornos
    Tipo Descrição
    vazio

    Este exemplo mostra uma solicitação de tipo de concessão de senha do proprietário do recurso.

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

    Este exemplo mostra uma solicitação de tipo de concessão de token de atualização.

    
         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)

    Define o escopo da cadeia de caracteres fornecida.

    Nota:
    Você só precisa definir o escopo se ele ainda não estiver definido no provedor OAuth.
    Tabela 27. Parâmetros
    Nome Tipo Descrição
    scope Cadeia de caracteres O escopo.
    Tabela 28. Retornos
    Tipo Descrição
    vazio

    GlideOAuthClientRequest – setUserName(cadeia de caracteres userName)

    Define o nome de usuário com a cadeia de caracteres fornecida.

    Tabela 29. Parâmetros
    Nome Tipo Descrição
    userName Cadeia de caracteres O nome de usuário.
    Tabela 30. Retornos
    Tipo Descrição
    vazio