Inhalt

Einleitung

Übersicht über die Umbrella API

API-Endgeräte und -Verwaltung

API-Anwendungsfälle und Endpunktgruppen

API-Schlüsselzugriff und -ablauf

Authentifizierung und Token-Lebenszyklus

Dokumentation und Ressourcen

Support

Einleitung

In diesem Dokument werden die Funktionen, Konfigurationsoptionen und verfügbaren Ressourcen für die Umbrella API-Plattform beschrieben.

Übersicht über die Umbrella API

Die Umbrella API-Plattform bietet eine sichere Umgebung für die Erstellung, Erweiterung und Integration mit Umbrella. Verwenden Sie die API, um plattformübergreifende Workflows zu erstellen, die Bedrohungsinformationen mit anderen Sicherheitslösungen zusammenführen, um die Durchsetzung zu erweitern, die Transparenz zu erhöhen und die Reaktion auf Vorfälle zu automatisieren.

API-Endgeräte und -Verwaltung

- Alle Umbrella API-Endpunkte werden unter gehostetapi.umbrella.com.

- Endpunkte werden nach Anwendungsfall gruppiert, jeder mit einem bestimmten Pfad.

- Verwalten Sie API-Schlüssel im Umbrella Dashboard unter Admin > API-Schlüssel oder programmgesteuert mithilfe der KeyAdmin-API.

API-Anwendungsfälle und Endpunktgruppen

Konfigurieren Sie jeden API-Schlüssel mit präzisen Anwendungsbereichen, die in die folgenden primären Anwendungsfälle gruppiert sind:

- Admin-API-Endpunkte: Bereitstellung und Management von API-Schlüsseln und -Benutzern, Anzeige von Rollen und Management von Kunden für Anbieter und Anbieter mit Managed Services

- API-Endpunkte für Authentifizierung: Autorisieren Sie Integrationen zwischen Umbrella und anderen Services.

- Bereitstellung von API-Endgeräten: Bereitstellung, Überwachung und Management von Netzwerken und Einheiten, deren Sicherung durch Konfiguration in vorhandenen Umbrella-Richtlinien

- Richtlinien-API-Endpunkte: Ziellisten und Ziele pro Liste bereitstellen und verwalten.

- API-Endpunkte untersuchen: Recherche zu Domänen, IP-Adressen und URLs, die von Umbrella-Resolvern beobachtet wurden

- meldet API-Endpunkte: Lesen und Überprüfen von Echtzeitinformationen zur Sicherheit von Bereitstellungen Die App Discovery API bietet Einblicke in Cloud-basierte Anwendungen.

API-Schlüsselzugriff und -ablauf

- Legen Sie die Zugriffsebene für jeden Bereich je nach beabsichtigter Verwendung auf "Lesen/Schreiben" oder "Schreibgeschützt" fest.

- Konfigurieren Sie die API-Schlüssel so, dass sie nach Bedarf an einem vordefinierten Datum ablaufen.

15143392160916

Authentifizierung und Token-Lebenszyklus

- API-Anmeldeinformationen generieren Zugriffstoken mit einer Gültigkeitsdauer von 60 Minuten.

- Bei der Authentifizierung wird der OAuth 2.0-Clientanmeldeinformationsfluss verwendet.

- In Umgebungen mit mehreren Organisationen oder Service Providern können API-Anmeldeinformationen der übergeordneten Organisation während der Autorisierung Zugriffstoken mit denselben Bereichen für eine bestimmte untergeordnete Organisation generieren.

Dokumentation und Ressourcen

- Greifen Sie auf umfassende Anweisungen und Dokumentation zu Anwendungsfällen zu.

- Jeder API-Anwendungsfall wird unter API-Referenz dokumentiert.

- Alle Endpunkte und Parameter werden in der OpenAPI-Spezifikation aufgelistet und am Ende jeder Fallübersicht miteinander verknüpft.

- Wenn Sie ältere Umbrella-APIs verwenden, lesen Sie den API-Migrationsleitfaden.

- Verwenden Sie die Postman Collection für die Umbrella API zum ersten Test.

- Weitere Ressourcen, Learning Labs und eine Sandbox für API-Tests finden Sie im Abschnitt zu Cloud Security auf der Cisco Developer Page.

Support

Wenden Sie sich bei Fragen oder zusätzlicher Unterstützung für die Umbrella API an den Umbrella Support.