Table des matières

Introduction

Présentation de l'API Umbrella

Terminaux et gestion API

Exemples d'utilisation des API et groupes de terminaux

Accès et expiration de la clé API

Authentification et cycle de vie des jetons

Documentation et ressources

Soutien

Introduction

Ce document décrit les fonctionnalités, les options de configuration et les ressources disponibles pour la plate-forme d'API Umbrella.

Présentation de l'API Umbrella

La plate-forme d'API Umbrella fournit un environnement sécurisé pour la création, l'extension et l'intégration d'Umbrella. Utilisez l'API pour créer des workflows inter-plates-formes qui agrègent les informations sur les menaces avec d'autres solutions de sécurité afin d'étendre l'application, d'améliorer la visibilité et d'automatiser la réponse aux incidents.

Terminaux et gestion API

- Tous les terminaux de l'API Umbrella sont hébergés surapi.umbrella.com.

- Les points d'extrémité sont regroupés par cas d'utilisation, chacun avec un chemin spécifique.

- Gérez les clés d'API dans le tableau de bord Umbrella sous Admin > Clés d'API ou par programme en utilisant l'API KeyAdmin.

Exemples d'utilisation des API et groupes de terminaux

Configurez chaque clé d'API avec des étendues granulaires regroupées sous ces exemples d'utilisation principaux :

- Terminaux API d'administration : Provisionnez et gérez les clés API et les utilisateurs, affichez les rôles et gérez les clients pour les fournisseurs et les fournisseurs gérés.

- Points de terminaison API d'authentification : Autoriser les intégrations entre Umbrella et d'autres services.

- Déploiements de terminaux API : Provisionnez, surveillez et gérez les réseaux et les entités, en les sécurisant en les configurant dans les politiques Umbrella existantes.

- Terminaux API des stratégies : Provisionnez et gérez les listes de destinations et les destinations par liste.

- Étudier les terminaux API : Recherchez les domaines, les adresses IP et les URL observés par les résolveurs Umbrella.

- Rapports sur les terminaux API : Lire et auditer les informations de sécurité en temps réel sur les déploiements. L'API App Discovery fournit des informations sur les applications cloud.

Accès et expiration de la clé API

- Définissez le niveau d'accès de chaque étendue sur Lecture/Écriture ou Lecture seule en fonction de l'utilisation prévue.

- Configurez les clés API pour qu'elles expirent à une date prédéfinie, le cas échéant.

15143392160916

Authentification et cycle de vie des jetons

- Les informations d'identification API génèrent des jetons d'accès valides pendant 60 minutes.

- Le processus d'authentification utilise le flux d'informations d'identification du client OAuth 2.0.

- Dans les environnements multi-organisations ou de fournisseurs de services, les informations d'identification API de l'organisation parent peuvent générer des jetons d'accès avec les mêmes étendues pour une organisation enfant spécifiée pendant l'autorisation.

Documentation et ressources

- Accédez à des instructions complètes et à la documentation du cas d'utilisation.

- Chaque cas d'utilisation d'API est documenté sous Référence d'API.

- Tous les terminaux et paramètres sont listés dans la spécification OpenAPI, liée au bas de chaque présentation de cas d'utilisation.

- Si vous utilisez des API Umbrella héritées, consultez le Guide de migration des API.

- Utilisez la collection Postman pour l'API Umbrella pour le test initial.

- Explorez d'autres ressources, des travaux pratiques et un sandbox pour les tests d'API dans la section Sécurité du cloud de la page des développeurs Cisco.

Soutien

Pour toute question ou assistance supplémentaire concernant l'API Umbrella, contactez le support Umbrella.