---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# OAuthUtil - Global

# OAuthUtil - Global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 min. de leitura

A inclusão de script OAuthUtil modifica os parâmetros de 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 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 de API do OAuth no formulário Registro de aplicações para provedores OAuth de terceiros. O nome da inclusão de script personalizado deve começar com <kbd class="ph userinput">OAuth</kbd>.  
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() {#ariaid-title2}

Retorna um GlideRecord que representa o perfil OAuth atual
{#r_OAuthUtilgetOAuthProfile__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 1. Parâmetros]

{#r_OAuthUtilgetOAuthProfile__table_qc4_bzf_cr} {#r_OAuthUtilgetOAuthProfile__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| GlideRecord | GlideRecord que representa o perfil OAuth atual |
[Tabela 2. Retorna]

{#r_OAuthUtilgetOAuthProfile__table_rc4_bzf_cr}

## OAuthUtil -- interceptRequestParameters(requestParamMap) {#ariaid-title3}

Adiciona um par nome:valor aos parâmetros de solicitação.
{#r_OAuthUtilinterceptRequestParameters__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| requestParamMap | Cadeia de caracteres | O par nome:valor que você deseja adicionar. |
[Tabela 3. Parâmetros]

{#r_OAuthUtilinterceptRequestParameters__table_qc4_bzf_cr} {#r_OAuthUtilinterceptRequestParameters__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 4. Retorna]

{#r_OAuthUtilinterceptRequestParameters__table_rc4_bzf_cr}

## OAuthUtil - parseTokenResponse(accessTokenResponse) {#ariaid-title4}

Analisa o token recebido em um mapa de parâmetros.
{#r_OAuthUtilParseTokenResponse__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| AcessTokenResponse | Cadeia de caracteres | A resposta do token de acesso que você deseja analisar. |
[Tabela 5. Parâmetros]

{#r_OAuthUtilParseTokenResponse__table_qc4_bzf_cr} {#r_OAuthUtilParseTokenResponse__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 6. Retorna]

{#r_OAuthUtilParseTokenResponse__table_rc4_bzf_cr}

## OAuthUtil - setEndpoint(url) {#ariaid-title5}

Definir o endpoint para sua solicitação OAuth
{#r_OAuthUtilsetEndpoint__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| URL | Cadeia de caracteres | Endpoint de URL para sua solicitação |
[Tabela 7. Parâmetros]

{#r_OAuthUtilsetEndpoint__table_qc4_bzf_cr} {#r_OAuthUtilsetEndpoint__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 8. Retorna]

{#r_OAuthUtilsetEndpoint__table_rc4_bzf_cr}

## OAuthUtil - setHeader(headerName, headerValue) {#ariaid-title6}

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

| 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 9. Parâmetros]

{#r_OAuthUtilsetHeader__table_qc4_bzf_cr} {#r_OAuthUtilsetHeader__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 10. Retorna]

{#r_OAuthUtilsetHeader__table_rc4_bzf_cr}

## OAuthUtil -- setQueryParameter(paramName, paramValue) {#ariaid-title7}

Adicione um parâmetro de consulta a uma solicitação OAuth.
{#r_OAuthUtilsetQueryParameter__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| paramName | Cadeia de caracteres | Nome do seu parâmetro |
| paramValue | Cadeia de caracteres | Valor do seu parâmetro |
[Tabela 11. Parâmetros]

{#r_OAuthUtilsetQueryParameter__table_qc4_bzf_cr} {#r_OAuthUtilsetQueryParameter__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 12. Retorna]

{#r_OAuthUtilsetQueryParameter__table_rc4_bzf_cr}