OAuthUtil - Global

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 1 min. de leitura

    • Esta inclusão de script modifica os parâmetros da solicitação e analisa a resposta do token durante o tempo de execução.

    Se o provedor OAuth externo retornar uma resposta diferente de uma resposta do tipo aplicação/JSON, você poderá personalizar sua própria versão desta inclusão de script para analisar as respostas que estão em formato diferente. Estenda ou copie esta inclusão de script e faça referência à sua versão no campo Script da API do OAuth no formulário de Registro da aplicação para provedores OAuth de terceiros. O nome da inclusão de script personalizado deve iniciar com OAuth.

    Por exemplo, se o provedor OAuth exigir um parâmetro de recurso com o valor https://outlook.office365.com, o código será semelhante a: 
    preprocessAccessToken: function(requestParamMap) {  requestParamMap.put("resource", "https://outlook.office365.com");  },

    OAuthUtil – getOAuthProfile()

    Retorna um GlideRecord que representa o perfil OAuth atual

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 2. Retorna
    Tipo Descrição
    GlideRecord GlideRecord que representa o perfil OAuth atual

    OAuthUtil - interceptRequestParameters(requestParamMap)

    Adiciona um par nome:valor aos parâmetros da solicitação.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    requestParamMap Cadeia de caracteres O par nome:valor que você deseja adicionar.
    Tabela 4. Retorna
    Tipo Descrição
    vazio

    OAuthUtil - parseTokenResponse(accessTokenResponse)

    Analisa o token recebido em um mapa de parâmetro.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    accessTokenResponse Cadeia de caracteres A resposta do token de acesso que você deseja analisar.
    Tabela 6. Retorna
    Tipo Descrição
    vazio

    OAuthUtil - setEndpoint(url)

    Definir o endpoint para sua solicitação OAuth

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    url Cadeia de caracteres Endpoint de URL para sua solicitação
    Tabela 8. Retorna
    Tipo Descrição
    vazio

    OAuthUtil - setHeader(headerName, headerValue)

    Adicione um cabeçalho a uma solicitação de token de saída.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    headerName Cadeia de caracteres Nome do cabeçalho da solicitação de token
    headerValue Cadeia de caracteres Valor do cabeçalho da solicitação de token
    Tabela 10. Retorna
    Tipo Descrição
    vazio

    OAuthUtil - setQueryParameter(paramName, paramValue)

    Adicione um parâmetro de consulta a uma solicitação OAuth.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    paramName Cadeia de caracteres Nome do seu parâmetro
    paramValue Cadeia de caracteres Valor do seu parâmetro
    Tabela 12. Retorna
    Tipo Descrição
    vazio