Como criar a política de acesso de REST API

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 2 min. de leitura
  • Crie uma política de acesso de API e mapeie um perfil de autenticação para restringir o tipo de autenticação de uma REST API. Por exemplo, você pode criar uma política de acesso de API que permita somente a autenticação de token de ID para uma REST API.

    Antes de Iniciar

    Certifique-se de criar um perfil de autenticação. Para obter mais informações, consulte Como criar um perfil de autenticação.

    Função necessária: administrador

    Procedimento

    1. Navegar até Tudo > Serviços web do sistema > Políticas de acesso da REST API.
    2. Selecione Novo.
    3. No formulário, preencha os campos obrigatórios e envie.
      Campos de política de acesso de API
      Nota:
      Reabra o formulário enviado para preencher campos adicionais.
      Tabela 1. Políticas de acesso de API
      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.
      Tabela As tabelas às quais a política de acesso à API se aplica. Esta opção se aplica somente a políticas do Tabela API.
      Aplicação Escopo da aplicação.
      Global Opção para aplicar a política a todos os métodos, versões e recursos da API.
      Aplicar a todos os métodos Opção para aplicar a política a todos os métodos, versões e recursos da API.
      Aplicar a todos os recursos Opção para aplicar a política a todos ou aos recursos de API.
      Aplicar a todas as versões Opção para aplicar a política a todas ou às versões da API.
      Aplicar a todas as tabelas Opção para aplicar a política a todas as tabelas. Esta opção se aplica somente a políticas do Tabela API.
      . Anuncie todos os esquemas de autenticação Determina se WWW-Authenticate o cabeçalho inclui todos os esquemas de autenticação configurados. Quando definido como falso (padrão), o cabeçalho inclui somente o perfil de autenticação configurado mais recentemente na política. Quando definido como verdadeiro , o cabeçalho lista todos os esquemas de autenticação configurados.
      Nota:
      Para entender mais sobre a priorização da política de acesso de API, consulte Priorização da política de acesso de API.
    4. Clique duas vezes em Inserir uma nova linha.
    5. Selecione um perfil de autenticação de entrada na lista e selecione o ícone Salvar ícone salvar.
      Por exemplo, você pode adicionar Autenticação básica, Token de ID, Autenticação baseada em certificados, OAuth ou Autenticação de WSSE.
      1. Para adicionar um ou mais perfis de autenticação de entrada, selecione Novo para criar um novo perfil.
      2. Selecione Que tipo de perfis de autenticação?.
        • Criar perfis de autenticação HTTP padrão
        • Criar perfis de autenticação de WSSE
        • Criar perfis de autenticação da chave de API
        • Criar perfis de autenticação de HMAC
        perfil de autenticação
      3. Depois de criar o perfil de autenticação, salve o registro.
    6. Selecione Enviar Para enviar a política de acesso da REST API.