---
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


---

# GlideOAuthClientRequest - com escopo, global

# GlideOAuthClientRequest - com escopo, global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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() {#ariaid-title2}

Recupera o tipo de concessão.
{#r_GlideOAuthClientRequestGetGrantType__table_qc4_bzf_cr__entry__3}

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

{#r_GlideOAuthClientRequestGetGrantType__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetGrantType__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | O tipo de concessão. |
[Tabela 2. Retorna]

{#r_GlideOAuthClientRequestGetGrantType__table_rc4_bzf_cr}

## GlideOAuthClientRequest -- getHeader(cadeia de caracteres name) {#ariaid-title3}

Recupera os cabeçalhos HTTP da cadeia de caracteres fornecida.
{#r_GlideOAuthClientRequestGetHeader__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | O nome do parâmetro. |
[Tabela 3. Parâmetros]

{#r_GlideOAuthClientRequestGetHeader__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetHeader__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| Mapa de cadeia de caracteres | O mapa de cadeia de caracteres com os cabeçalhos HTTP. |
[Tabela 4. Retorna]

{#r_GlideOAuthClientRequestGetHeader__table_rc4_bzf_cr}

## GlideOAuthClientRequest -- getHeaders() {#ariaid-title4}

Recupera os cabeçalhos HTTP.
{#r_GlideOAuthClientRequestGetHeaders__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nenhum |   |   |
[Tabela 5. Parâmetros]

{#r_GlideOAuthClientRequestGetHeaders__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetHeaders__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| Mapa de cadeia de caracteres | O mapa de cadeia de caracteres com os cabeçalhos HTTP. |
[Tabela 6. Retorna]

{#r_GlideOAuthClientRequestGetHeaders__table_rc4_bzf_cr}

## GlideOAuthClientRequest -- getParameter(cadeia de caracteres name) {#ariaid-title5}

Recupera os parâmetros para o nome do parâmetro fornecido.
{#r_GlideOAuthClientRequestGetParameter__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | O nome do parâmetro para o qual você deseja os parâmetros. |
[Tabela 7. Parâmetros]

{#r_GlideOAuthClientRequestGetParameter__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetParameter__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Os parâmetros. |
[Tabela 8. Retorna]

{#r_GlideOAuthClientRequestGetParameter__table_rc4_bzf_cr}

## GlideOAuthClientRequest -- getPassword() {#ariaid-title6}

Recupera a senha.
{#r_GlideOAuthClientRequestGetPassword__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nenhum |   |   |
[Tabela 9. Parâmetros]

{#r_GlideOAuthClientRequestGetPassword__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetPassword__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | A senha. |
[Tabela 10. Retorna]

{#r_GlideOAuthClientRequestGetPassword__table_rc4_bzf_cr}

## GlideOAuthClientRequest -- getRefreshToken() {#ariaid-title7}

Recupera o token de atualização.
{#r_GlideOAuthClientRequestGetRefreshToken__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nenhum |   |   |
[Tabela 11. Parâmetros]

{#r_GlideOAuthClientRequestGetRefreshToken__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetRefreshToken__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | O token de atualização. |
[Tabela 12. Retorna]

{#r_GlideOAuthClientRequestGetRefreshToken__table_rc4_bzf_cr}

## GlideOAuthClientRequest -- getScope() {#ariaid-title8}

Recupera o escopo.
{#r_GlideOAuthClientRequestGetScope__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nenhum |   |   |
[Tabela 13. Parâmetros]

{#r_GlideOAuthClientRequestGetScope__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetScope__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | O escopo. |
[Tabela 14. Retorna]

{#r_GlideOAuthClientRequestGetScope__table_rc4_bzf_cr}

## GlideOAuthClientRequest -- getUserName() {#ariaid-title9}

Recupera o nome de usuário.
{#r_GlideOAuthClientRequestGetUserName__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nenhum |   |   |
[Tabela 15. Parâmetros]

{#r_GlideOAuthClientRequestGetUserName__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetUserName__table_rc4_bzf_cr__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | O nome de usuário. |
[Tabela 16. Retorna]

{#r_GlideOAuthClientRequestGetUserName__table_rc4_bzf_cr}

## GlideOAuthClientRequest -- setGrantType(cadeia de caracteres "grantType") {#ariaid-title10}

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.
{#r_GlideOAuthClientRequestSetGrantType__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | O tipo de concessão. |
[Tabela 17. Parâmetros]

{#r_GlideOAuthClientRequestSetGrantType__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestSetGrantType__table_rc4_bzf_cr__entry__2}

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

{#r_GlideOAuthClientRequestSetGrantType__table_rc4_bzf_cr}

## GlideOAuthClientRequest - setHead(cadeia de caracteres nome, cadeia de caracteres valor) {#ariaid-title11}

Recupera os cabeçalhos HTTP da cadeia de caracteres fornecida.
{#r_GlideOAuthClientRequestSetHead__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | O nome do parâmetro. |
| valor | Cadeia de caracteres | O valor do parâmetro. |
[Tabela 19. Parâmetros]

{#r_GlideOAuthClientRequestSetHead__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestSetHead__table_rc4_bzf_cr__entry__2}

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

{#r_GlideOAuthClientRequestSetHead__table_rc4_bzf_cr}

## GlideOAuthClientRequest - setParameter(cadeia de caracteres nome, cadeia de caracteres valor) {#ariaid-title12}

Define os parâmetros para o par de cadeias de caracteres nome:valor fornecido.
{#r_GOACR-SetParameters_N_V__table_qc4_bzf_cr__entry__3}

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

{#r_GOACR-SetParameters_N_V__table_qc4_bzf_cr} {#r_GOACR-SetParameters_N_V__table_rc4_bzf_cr__entry__2}

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

{#r_GOACR-SetParameters_N_V__table_rc4_bzf_cr}

## GlideOAuthClientRequest -- setPassword(cadeia de caracteres de senha) {#ariaid-title13}

Define a senha com a cadeia de caracteres fornecida.
{#r_GlideOAuthClientRequestSetPassword__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| senha | Cadeia de caracteres | O nome de usuário. |
[Tabela 23. Parâmetros]

{#r_GlideOAuthClientRequestSetPassword__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestSetPassword__table_rc4_bzf_cr__entry__2}

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

{#r_GlideOAuthClientRequestSetPassword__table_rc4_bzf_cr}

## GlideOAuthClientRequest -- setRefreshToken(cadeia de caracteres refreshToken) {#ariaid-title14}

Define o token de atualização com a cadeia de caracteres fornecida.
{#r_GlideOAuthClientRequestSetRefreshToken__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| atualizarToken | Cadeia de caracteres | O token de atualização. |
[Tabela 25. Parâmetros]

{#r_GlideOAuthClientRequestSetRefreshToken__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestSetRefreshToken__table_rc4_bzf_cr__entry__2}

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

{#r_GlideOAuthClientRequestSetRefreshToken__table_rc4_bzf_cr}  
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) {#ariaid-title15}

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.
{#r_GlideOAuthClientRequestSetScope__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| scope | Cadeia de caracteres | O escopo. |
[Tabela 27. Parâmetros]

{#r_GlideOAuthClientRequestSetScope__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestSetScope__table_rc4_bzf_cr__entry__2}

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

{#r_GlideOAuthClientRequestSetScope__table_rc4_bzf_cr}

## GlideOAuthClientRequest -- setUserName(cadeia de caracteres userName) {#ariaid-title16}

Define o nome de usuário com a cadeia de caracteres fornecida.
{#r_GlideOAuthClientRequestSetUserName__table_qc4_bzf_cr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| userName | Cadeia de caracteres | O nome de usuário. |
[Tabela 29. Parâmetros]

{#r_GlideOAuthClientRequestSetUserName__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestSetUserName__table_rc4_bzf_cr__entry__2}

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

{#r_GlideOAuthClientRequestSetUserName__table_rc4_bzf_cr}