Pular para o conteúdo principal
Duas operações da API do Identity gerenciam a lista de IPs permitidos: uma a lê, outra a substitui. Use-as quando você gerencia as configurações de segurança pelas suas próprias ferramentas em vez do Console. A referência da API documenta as duas operações: Obter a IP allowlist da organização e Definir a IP allowlist da organização.

​
As duas operações

As duas operações ficam na URL base da API do Identity e precisam de um bearer token. A plataforma resolve o seu workspace a partir do token. Não existe identificador de organização no caminho nem no corpo.

​
O corpo

O corpo de requisição do PUT e o corpo de resposta das duas operações têm estes campos:
Regras que valem para os campos:
  • entries é uma substituição completa. Para acrescentar um endereço, envie a lista atual mais o novo endereço.
  • Em uma requisição, você pode enviar uma entrada como texto com o endereço ou como um objeto com cidr e description. Você pode misturar as duas formas.
  • A plataforma guarda uma entrada em texto com uma descrição vazia. Para manter uma descrição, envie essa entrada como objeto de novo.
  • Uma entrada mais ampla que /24 para IPv4 ou /48 para IPv6 é recusada com 400, e nada muda.
  • A resposta devolve as entradas como a plataforma as guardou. Um endereço único volta com o prefixo dele: 198.51.100.7 vira 198.51.100.7/32.
  • entries: [] desativa a lista. A operação retorna 200.
  • Uma lista guardada vazia é serializada como [], nunca como null.
  • Quando você omite scopes, os escopos guardados ficam como estão.
  • scopes: [] mantém as entradas mas para a aplicação da lista em todo lugar.
  • Quando você omite entries, a operação retorna 400 com o código IDE-0001 e nada muda.

​
Exemplos

Troque os espaços reservados pela URL base da sua API do Identity e por um bearer token que tenha a permissão security.
Um PUT bem-sucedido retorna 200 com a lista guardada:

​
Ordem recomendada

1

Cadastre os endereços apenas com o escopo console

Envie a lista completa com "scopes": ["console"]. Inclua o endereço de onde você chama.
2

Confirme que você ainda consegue entrar

Entre no Console a partir de um endereço listado. Depois tente a partir de um endereço não listado e espere uma recusa.
3

Liste o endereço de saída de cada integração

Reúna o endereço de onde cada ERP, disparador de webhook, job agendado e application chama. Acrescente cada um a entries.
4

Acrescente o escopo api

Envie a lista completa de novo com "scopes": ["console", "api"]. Acompanhe as suas integrações em busca de respostas 403.

​
Erros

Cada erro usa o envelope do Access Manager com os campos code, title e message. As entradas guardadas, separadas por vírgulas, devem caber em 200 caracteres. As descrições não contam.
Olhe o campo code, não apenas o status. Um 403 com o código AUT-0021 pode voltar de qualquer endpoint protegido, inclusive dessas duas operações, quando o seu próprio endereço está fora de uma lista ativa. Nesse caso a lista não mudou e você deve chamar a partir de um endereço listado.

​
Páginas relacionadas

Lista de IPs permitidos

O que o recurso protege, como ele decide e o que ele não cobre.

Lista de erros do Access Manager

Cada código de erro do Auth e do Identity, com título e mensagem.