Contents

Introdução

Visão geral da API Umbrella

Endpoints e gerenciamento de API

Casos de uso de API e grupos de endpoint

Acesso e Expiração da Chave de API

Autenticação e ciclo de vida do token

Documentação e recursos

Support

Introdução

Este documento descreve os recursos, as opções de configuração e os recursos disponíveis para a plataforma Umbrella API.

Visão geral da API Umbrella

A plataforma de API do Umbrella oferece um ambiente seguro para construção, extensão e integração com o Umbrella. Use a API para criar fluxos de trabalho entre plataformas que agregam inteligência de ameaças a outras soluções de segurança para expandir a aplicação, aumentar a visibilidade e automatizar a resposta a incidentes.

Endpoints e gerenciamento de API

- Todos os endpoints de API Umbrella são hospedados emapi.umbrella.com.

- Os endpoints são agrupados por caso de uso, cada um com um caminho específico.

- Gerencie chaves de API no painel Umbrella em Admin > chaves de API ou programaticamente usando a API KeyAdmin.

Casos de uso de API e grupos de endpoint

Configure cada chave de API com escopos granulares agrupados nestes casos de uso principais:

- Pontos de extremidade da API de administração: Provisione e gerencie chaves de API e usuários, visualize funções e gerencie clientes para provedores e provedores gerenciados.

- Pontos de extremidade de API de autenticação: Autorizar integrações entre a Umbrella e outros serviços.

- Pontos de extremidade da API de implantações: Provisione, monitore e gerencie redes e entidades, protegendo-as ao configurá-las nas políticas atuais do Umbrella.

- Pontos de extremidade de API de políticas: Provisione e gerencie listas de destinos e destinos por lista.

- Investigar pontos de extremidade da API: Pesquise domínios, endereços IP e URLs observados pelos resolvedores do Umbrella.

- Relatórios de pontos de extremidade de API: Leia e audite informações de segurança em tempo real sobre implantações. A API do App Discovery oferece insights sobre aplicativos baseados em nuvem.

Acesso e Expiração da Chave de API

- Defina o nível de acesso para cada escopo como Leitura/Gravação ou Somente Leitura de acordo com a finalidade.

- Configure as chaves de API para expirar em uma data predefinida, conforme necessário.

15143392160916

Autenticação e ciclo de vida do token

- As credenciais de API geram tokens de acesso válidos por 60 minutos.

- O processo de autenticação usa o fluxo de credenciais do cliente OAuth 2.0.

- Em ambientes multiorganizações ou de provedores de serviços, as credenciais de API da organização pai podem gerar tokens de acesso com os mesmos escopos para uma organização filha especificada durante a autorização.

Documentação e recursos

- Acesse instruções abrangentes e a documentação do caso de uso.

- Cada caso de uso de API é documentado em Referência de API.

- Todos os endpoints e parâmetros são listados na especificação OpenAPI, vinculada na parte inferior de cada visão geral de caso de uso.

- Se você usa APIs Umbrella antigas, consulte o Guia de Migração de APIs.

- Use a coleção Postman para a API Umbrella para o teste inicial.

- Explore recursos adicionais, laboratórios de aprendizado e um Sandbox para testes de API na seção Segurança de nuvem da página do desenvolvedor da Cisco.

Support

Para dúvidas ou obter assistência adicional com a API do Umbrella, entre em contato com o suporte do Umbrella.