Contenido

Introducción

Descripción general de Umbrella API

Gestión y terminales de API

Casos prácticos de API y grupos de terminales

API Key Access y Expiry

Autenticación y ciclo de vida del token

Documentación y recursos

Support

Introducción

Este documento describe las características, opciones de configuración y recursos disponibles para la plataforma Umbrella API.

Descripción general de Umbrella API

La plataforma Umbrella API proporciona un entorno seguro para crear, ampliar e integrar Umbrella. Utilice la API para crear flujos de trabajo multiplataforma que agregan inteligencia de amenazas con otras soluciones de seguridad para ampliar la aplicación, aumentar la visibilidad y automatizar la respuesta a incidentes.

Gestión y terminales de API

- Todos los terminales de la API Umbrella se alojan enapi.umbrella.com.

- Los extremos se agrupan por caso de uso, cada uno con una ruta de acceso específica.

- Administre las claves API en el panel Umbrella en Admin > API keys o mediante programación mediante la API KeyAdmin.

Casos prácticos de API y grupos de terminales

Configure cada clave de API con ámbitos granulares agrupados en estos casos prácticos principales:

- Terminales API de administración: Aprovisione y administre claves API y usuarios, vea funciones y administre clientes para proveedores y proveedores administrados.

- Terminales API de autenticación: Autorizar integraciones entre Umbrella y otros servicios.

- Implementaciones de terminales API: Aprovisionar, supervisar y gestionar redes y entidades, protegiéndolas mediante su configuración en las políticas generales existentes.

- Políticas Terminales API: Aprovisionar y administrar listas de destinos y destinos por lista.

- Investigue los terminales de API: Dominios de investigación, direcciones IP y URL observados por los solucionadores de Umbrella.

- Informa sobre los terminales API: Lea y audite la información de seguridad en tiempo real sobre las implementaciones. La API de App Discovery proporciona información sobre las aplicaciones basadas en la nube.

API Key Access y Expiry

- Establezca el nivel de acceso de cada ámbito en Lectura/escritura o Sólo lectura según el uso esperado.

- Configure las claves API para que venzan en una fecha predefinida según sea necesario.

15143392160916

Autenticación y ciclo de vida del token

- Las credenciales de API generan tokens de acceso válidos durante 60 minutos.

- El proceso de autenticación utiliza el flujo de credenciales del cliente OAuth 2.0.

- En entornos de varias organizaciones o proveedores de servicios, las credenciales de la API de la organización principal pueden generar tokens de acceso con los mismos ámbitos para una organización secundaria especificada durante la autorización.

Documentación y recursos

- Acceda a instrucciones completas y a documentación de casos prácticos.

- Cada caso práctico de API se documenta en Referencia de API.

- Todos los terminales y parámetros se enumeran en la especificación OpenAPI, vinculada en la parte inferior de cada descripción general del caso práctico.

- Si utiliza API Umbrella heredadas, consulte la Guía de migración de API.

- Utilice la colección Postman para la API Umbrella para las pruebas iniciales.

- Explore recursos adicionales, laboratorios de aprendizaje y un espacio aislado para las pruebas de API en la sección Seguridad de la nube de la página para desarrolladores de Cisco.

Support

Si tiene alguna pregunta o necesita ayuda adicional con la API de Umbrella, póngase en contacto con el servicio de asistencia de Umbrella.