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


---

# Configurar HMAC - Autenticação baseada em token

# Configurar HMAC - Autenticação baseada em token {#ariaid-title1}

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

Configure o HMAC para oferecer suporte à autenticação de endpoints de REST API.

## Antes de Iniciar

Função necessária: administrador

Plug-in necessário: chave de API e autenticação HMAC (<kbd class="ph userinput">com.glide.tokenbased_auth</kbd>)

## Procedimento

1. Crie uma configuração HMAC.
   1. Navegar até TudoServiços web do sistemaPolíticas de acesso de APIConfiguração de HMAC.
   2. Selecione Novo.  
      Nota:  
      Você também pode usar a Codificação HMAC SHA256 Base64 padrão que é criada durante a instalação do plug-in.
   3. No formulário, preencha os campos:  
      {#configure-hmac__table_y3b_h1f_nzb__entry__2}

      | Campo | Descrição |
      |-|-|
      | Nome | Nome da configuração do HMAC. |
      | Aplicação | Escopo da configuração. |
      | Descrição | Descrição detalhada da configuração. |
      | Algoritmo de hash | Escolha o Algoritmo de hash. Opções disponíveis: * HmacSHA256 * HmacSHA384 * HmacSHA512 {#configure-hmac__ul_llc_4vs_pzb} |
      | Script do utilitário do HMAC | Script de utilitário para HMAC. Nota: Se você validar a autenticação HMAC usando o corpo da solicitação, o carimbo de data/hora e o segredo sem ID de chave, faça o seguinte: * Crie uma inclusão de script personalizada como script do utilitário HMAC * Use esse utilitário de inclusão de script para interpretar o carimbo de data/hora da aprovação e o corpo da solicitação. {#configure-hmac__ul_o53_5qy_jbc} Para cada segredo compartilhado criado na instância da ServiceNow®, há um ID de chave. É necessário configurar o ID da chave como o ID de chave padrão no perfil de autenticação HMAC. |
      [Tabela 1. Configuração do HMAC]

      {#configure-hmac__table_y3b_h1f_nzb}
   4. Envie o registro.
   {#configure-hmac__substeps_y2w_tz2_nzb}
2. Crie um perfil de autenticação de entrada.
   1. Navegar até TudoServiços web do sistemaPolíticas de acesso de APIPerfis de autenticação de entrada.
   2. Selecione Novo.  
      O sistema exibe a mensagem Que tipo de perfil de autenticação?
   3. Selecione Criar perfis de autenticação de HMAC.  
   4. No formulário, preencha os campos.  
      {#configure-hmac__table_nnk_yqx_mzb__entry__2}

      | Campo | Descrição |
      |-|-|
      | Nome | Nome para identificar a política de autenticação. |
      | Aplicação | Escopo da política de autenticação. |
      | Configuração do HMAC | Selecione a configuração de HMAC que você criou. |
      | Parâmetro de autenticação | Selecione o parâmetro de autenticação para a solicitação de autenticação. Você pode selecionar as opções padrão ou criar um novo parâmetro de autenticação: * x-sn-hmac-signature-256: cabeçalho de autenticação * x-sn-hmac-signature-256: parâmetro de consulta {#configure-hmac__ul_ejm_4w4_nzb} |
      | ID de chave padrão do segredo compartilhado | As informações de token que podem ser atualizadas neste campo para usar o HMAC. |
      [Tabela 2. Perfis de autenticação de HMAC]

      {#configure-hmac__table_nnk_yqx_mzb}  
      Nota:  
      A opção selecionada deve ser definida na chamada REST como parte do cabeçalho de autenticação ou do parâmetro de consulta.
   5. Envie o formulário.
   {#configure-hmac__substeps_dv3_yy2_nzb}
3. Crie um segredo do HMAC.
   1. Navegar até TudoServiços web do sistemaPolíticas de acesso de APISegredo do HMAC da REST API.
   2. Selecione Novo.
   3. No formulário, preencha os campos:  
      {#configure-hmac__table_tpz_x1f_nzb__entry__2}

      | Campo | Descrição |
      |-|-|
      | Nome | Nome para identificar o segredo do HMAC da REST API. |
      | Descrição | Descrição do segredo do HMAC da REST API. |
      | Ativo | Status do segredo do HMAC da REST API. |
      | Usuário | Usuário associado ao segredo do HMAC da REST API. Use o ícone de pesquisa para selecionar o usuário. |
      | ID da chave | ID da chave que deve ser enviada como parte da chamada REST. O ID da chave é gerado após o envio do formulário. |
      | Segredo compartilhado | Segredos compartilhados do usuário. Por exemplo, a senha. |
      | Origem | Origem do registro. |
      | Vencimento | Prazo após o qual a credencial não é mais válida. Um valor vazio significa que não há vencimento. Nota: Para obter mais informações sobre a expiração do token, consulte [Como limpar o vencimento de tokens](https://servicenow-prod.fluidtopics.net/POezrzZygfnixle8oqDT0A "Detalhes sobre como limpar o vencimento de tokens usando diferentes propriedades do sistema."). |
      [Tabela 3. Segredo do HMAC da REST API]

      {#configure-hmac__table_tpz_x1f_nzb}
   4. Envie o formulário.
   5. Abra o registro que foi criado.  
      Encontre o ID da chave gerado pela Now Platform para o usuário.  
      Nota:  
      Você pode adicionar o ID da chave que foi gerado durante o ID da chave no perfil de autenticação criado para o HMAC se não quiser especificar o parâmetro de autenticação ou de consulta para a chamada de API.
   {#configure-hmac__substeps_yn3_r1f_nzb}
4. Crie uma política de acesso de REST API.
   1. Navegar até TudoServiços web do sistemaPolíticas de acesso de REST API.
   2. Selecione Novo.
   3. No formulário, preencha os campos.  
      {#configure-hmac__table_d4x_w45_d4b__entry__2}

      | Campo | Descrição |
      |-|-|
      | Nome | Nome exclusivo da política de acesso de API. |
      | Ativo | Opção para ativar a política de acesso de API. |
      | REST API | A REST API à qual a política de acesso é aplicada. Por exemplo, API de anexos. |
      | REST API PATH | Caminho da API da REST API. Esse campo é preenchido automaticamente com base na REST API selecionada. Por exemplo, now/attachment. |
      | Método HTTP | Método usado para interagir com a API. Esse campo é preenchido automaticamente com base na REST API selecionada. |
      | Versão | Versão da API. Por exemplo, v1. Esse campo é preenchido automaticamente com base na REST API selecionada. Nota: Se você quiser criar uma política de autenticação para todas as versões de uma REST API, deverá criar políticas individuais para cada versão. |
      | Recurso | Recurso secundário da REST API. Esse campo é preenchido automaticamente com base na REST API selecionada. Por exemplo, /now/attachment. |
      | Aplicação | Escopo da aplicação. |
      | Global | Habilite este campo para aplicar a política de autenticação a todos os métodos, versões e recursos para a API. Nota: A autenticação baseada em token não é permitida na política da REST API global. |
      | Aplicar a todos os métodos | Habilite este campo para aplicar a política de autenticação para a API a todos os métodos, versões e recursos para a API. |
      | Aplicar a todos os recursos | Habilite este campo para aplicar a política de autenticação para a API a todas as versões. |
      | Aplicar a todas as versões | Habilite este campo para aplicar a política de autenticação para a API a todos os recursos. |
      [Tabela 4. Políticas de acesso de API]

      {#configure-hmac__table_d4x_w45_d4b}
   4. Adicione o perfil de autenticação de API que foi criado.  
   5. Envie o formulário.  
      Você pode enviar a chamada de REST API:
      * Com a x-sn-hmac-signature-256 gerada por ServiceNow® durante a criação da chave de API no cabeçalho ou no parâmetro de consulta com base na configuração para autenticação.
      * Com o Script de pré-solicitação, junto ao Segredo compartilhado especificado como parte da solicitação.

      {#configure-hmac__ul_upf_rsv_pzb}  
      Aviso:  
      Use a solicitação POST ao enviar informações confidenciais para o servidor.
   {#configure-hmac__substeps_ypz_h5x_mzb}