GlideOAuthClient - com escopo, global

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 2 min. de leitura
  • A API GlideOAuthClient fornece métodos para solicitar e revogar tokens de acesso e atualização do OAuth.

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

    GlideOAuthClient – getToken(cadeia de caracteres requestID, cadeia de caracteres oauthProfileID)

    Recupera os tokens de acesso e atualização do cliente.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    requestID Cadeia de caracteres ID da solicitação da tabela Perfil do solicitante do OAuth [oauth_requestor_profile], que faz referência à tabela Perfil da entidade OAuth [oauth_entity_profile].
    OAuthProfileID Cadeia de caracteres ID do perfil OAuth da tabela Perfil de entidade OAuth [oauth_entity_profile].
    Tabela 2. Retorna
    Tipo Descrição
    GlideOAuthToken Os tokens de acesso e atualização do cliente.

    Este código de exemplo mostra como recuperar tokens de acesso e atualização do banco de dados da instância.

    function dumpToken(token) {
      if(token) {
         gs.info("AccessToken:" + token.getAccessToken());
         gs.info("AccessTokenExpiresIn:" + token.getExpiresIn());
         gs.info("RefreshToken:" + token.getRefreshToken());
      }
    }
    
    var oAuthClient = new  sn_auth.GlideOAuthClient();
    var token = oAuthClient.getToken('248e3017c302301089a7dd5c2840dda5', '9c4e78d3c302301089a7dd5c2840dd76');
    dumpToken(token);

    Saída:

    *** Script: AccessToken:6MRxD3TRYYvIaoKr-JCy3KiaOxBPu4C9k8oafo3MYf9q8zDyHQr8UzMSM3Md2alfaES1rzSYe5ydqgbOwpm7TA
    *** Script: AccessTokenExpiresIn:1207
    *** Script: RefreshToken:sc0iTK-0PcVkRi14HXPM3vT0FyOPO8iCqC10huQoDSSLBGUSnmEv_fUfJzGWCWBb_StsXIOz6r8qF-hRhURWTA

    GlideOAuthClient - requestToken (cadeia de caracteres clientName, cadeia de caracteres jsonString)

    Recupera o token do cliente, com os parâmetros de solicitação codificados no formato JSON.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    clientName Cadeia de caracteres O nome do cliente.
    jsonString Cadeia de caracteres A cadeia de caracteres JSON do cliente.
    Tabela 4. Retorna
    Tipo Descrição
    GlideOAuthClientResponse O token do cliente.

    Este exemplo mostra uma solicitação do tipo de concessão de senha do proprietário do recurso, com parâmetros de solicitação codificados no formato JSON.

    
    var oAuthClient = new GlideOAuthClient();
    var params ={grant_type:"password", username:"itil", password:'itil'};
    var json =new JSON();
    var text = json.encode(params);
    var tokenResponse = oAuthClient.requestToken('TestClient', text);
    var token = tokenResponse.getToken();
    
    gs.log("AccessToken:"+ token.getAccessToken());
    gs.log("AccessTokenExpiresIn:"+ token.getExpiresIn());
    gs.log(" RefreshToken:"+ token.getRefreshToken());
    

    GlideOAuthClient – requestTokenByRequest(cadeia de caracteres clientName, solicitação GlideOAuthClientRequest)

    Recupera o token do cliente, com o nome do cliente e a solicitação definida em um objeto GlideOAuthClientResponse.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    clientName Cadeia de caracteres O nome do cliente.
    solicitação GlideOAuthClientRequest A solicitação.
    Tabela 6. Retorna
    Tipo Descrição
    GlideOAuthClientResponse O token do cliente.

    GlideOAuthClient - revokeToken(cadeia de caracteres clientName, cadeia de caracteres accessToken, cadeia de caracteres refreshToken, solicitação GlideOAuthClientRequest)

    Revoga o token de acesso ou de atualização do cliente, com a solicitação e os parâmetros de cabeçalho opcionais definidos em um objeto GlideOAuthClientRequest.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    clientName Cadeia de caracteres O nome do cliente.
    token de acesso Cadeia de caracteres O token de acesso.
    atualizarToken Cadeia de caracteres O token de atualização.
    solicitação GlideOAuthClientRequest A solicitação.
    Tabela 8. Retorna
    Tipo Descrição
    GlideOAuthClientResponse O token do cliente.