---
sourceDocument: Segurança da plataforma Yokohama
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/yokohama/platform-security

 Release :

    - yokohama

ft:locale :

    - pt-BR

ft:publication_title :

    - Segurança da plataforma Yokohama

ft:clusterId :

    - psec

bundleId :

    - psec

workflow :

    - Platform


---

# Como configurar o escopo de autenticação da REST API

# Como configurar o escopo de autenticação da REST API {#ariaid-title1}

* Versão de lançamento: Yokohama
* 
* Atualizado 30 de jan. de 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 min. de leitura

Vincule a entidade OAuth a um escopo de autenticação para gerenciar o token para acessar as REST APIs que estão vinculadas ao escopo de autenticação.

## Antes de Iniciar

Instale os seguintes plug-ins:

* OAuth 2.0
* REST API Provider
* Escopo de autenticação
* REST API Auth Scope

{#configure-rest-api-auth-scope__ul_xg5_pfn_4tb}  
Nota:  
O plug-in REST API Auth Scope é adicionado como parte da versão Tokyo.

Função necessária: administrador

## Procedimento

1. Navegar até TudoEscopos de autenticação da APIEscopo de autenticação da REST API.  
   A página Escopos de autenticação da REST API é exibida.
2. Para configurar um novo Escopo de autenticação da REST API, clique em Novo.
3. No formulário, preencha os campos.  
   {#configure-rest-api-auth-scope__table_sss_z55_4tb__entry__2}

   |   |   |
   |-|-|
   | Nome | Um nome exclusivo que identifica o Escopo de autenticação da REST API. |
   | Ativo | Marque a caixa de seleção para ativar a configuração. |
   | Aplicação | Escopo da aplicação de somente leitura. |
   | REST API | A REST API à qual o escopo de autenticação é aplicado. Por exemplo, a API da tabela. |
   | Escopo de autenticação | Selecione o escopo de autenticação no ícone de pesquisa. |
   | REST API PATH | Caminho da API da REST API. Esse campo é preenchido automaticamente com base na REST API selecionada. Por exemplo, "now/table". |
   | Método HTTP | Método usado para interagir com a API. Selecione o método na lista suspensa. Você pode desabilitar manualmente o campo Aplicar escopo de autenticação a todos os métodos HTTP nesta API no formulário para selecionar o método. |
   | Versão da REST API | Versão da API. Por exemplo, v1. Esse campo é preenchido automaticamente com base na REST API selecionada. Você pode desabilitar manualmente o campo Aplicar escopo de autenticação a todas as versões nesta API no formulário para selecionar a versão. |
   | Recurso | Recurso secundário da REST API. Esse campo é preenchido automaticamente com base na REST API selecionada. Por exemplo, "/now/table". Você pode desabilitar manualmente o campo Aplicar escopo de autenticação a todos os recursos nesta API no formulário para selecionar os recursos. |
   | Aplicar escopo de autenticação a todos os métodos HTTP nesta API | Quando habilitado, aplica o escopo de autenticação a todos os métodos HTTP na API. |
   | Aplicar escopo de autenticação a todas as versões nesta API | Quando habilitado, aplica o escopo de autenticação a todas as versões na API. |
   | Aplicar escopo de autenticação a todos os recursos nesta API | Quando habilitado, aplica o escopo de autenticação a todos os recursos na API. |
   [Tabela 1. Escopo de autenticação da REST API]

   {#configure-rest-api-auth-scope__table_sss_z55_4tb}
4. Clique em Enviar.  
   Com base na REST API e no escopo de autenticação selecionados, as APIs recuperam informações específicas do escopo.

## Considere criar três escopos de autenticação da REST API para a API da tabela {#configure-rest-api-auth-scope__example_gnr_fx5_4tb}

O primeiro escopo de autenticação é mapeado para a API da tabela com todos os métodos HTTP, versões e recursos habilitados.

O segundo escopo de autenticação é mapeado para a API da tabela com todas as versões e recursos habilitados. Mas, neste exemplo, escolhe-se o método GET no método HTTP.

O terceiro escopo de autenticação é mapeado para a API da tabela sem os métodos HTTP, versões e recursos habilitados. Você escolherá manualmente o método HTTP, a versão e o recurso. Neste exemplo, o método HTTP é GET, a versão da REST API é a mais recentee o recurso é `/now/table/{tableName}`.

Se todos esses escopos de autenticação forem criados, você poderá usar o método GET com todos os três escopos, mas para os métodos POST, PUT, DELETEou PATCH, somente o escopo 3 poderá ser usado.