Inhoud

Inleiding

Overzicht van Umbrella API

API-eindpunten en beheer

API Use Cases en Endpoint Groups

Toegang tot en vervaldatum API-sleutel

Authenticatie en levenscyclus token

Documentatie en middelen

steunen

Inleiding

In dit document worden de functies, configuratieopties en beschikbare bronnen voor het Umbrella API-platform beschreven.

Overzicht van Umbrella API

Het Umbrella API-platform biedt een veilige omgeving voor het bouwen, uitbreiden en integreren met Umbrella. Gebruik de API om platformonafhankelijke workflows te maken die dreigingsinformatie samenvoegen met andere beveiligingsoplossingen om de handhaving uit te breiden, de zichtbaarheid te vergroten en incidentrespons te automatiseren.

API-eindpunten en beheer

- Alle Umbrella API-eindpunten worden gehost opapi.umbrella.com.

- Eindpunten worden gegroepeerd per use case, elk met een specifiek pad.

- API-sleutels beheren in het Umbrella-dashboard onder Beheer > API-sleutels of programmatisch met behulp van de KeyAdmin API.

API Use Cases en Endpoint Groups

Configureer elke API-sleutel met granulaire scopes gegroepeerd onder deze primaire use cases:

- API-eindpunten beheren: API-sleutels en gebruikers verstrekken en beheren, rollen bekijken en klanten beheren voor providers en beheerde providers.

- Auth API-eindpunten: Integraties tussen Umbrella en andere services toestaan.

- Implementaties API-eindpunten: netwerken en entiteiten aanbieden, bewaken en beheren, beveiligen door ze te configureren in bestaand overkoepelend beleid.

- Policies API-eindpunten: bestemmingslijsten en bestemmingen per lijst aanbieden en beheren.

- API-eindpunten onderzoeken: onderzoeksdomeinen, IP-adressen en URL's die worden waargenomen door Umbrella Resolvers.

- Rapporten API-eindpunten: lees en controleer real-time beveiligingsinformatie over implementaties. De App Discovery API biedt inzicht in cloud-gebaseerde applicaties.

Toegang tot en vervaldatum API-sleutel

- Stel het toegangsniveau voor elk bereik in op Lezen / Schrijven of Alleen-lezen op basis van het beoogde gebruik.

- Configureer API-sleutels om te verlopen op een vooraf gedefinieerde datum zoals vereist.

15143392160916

Authenticatie en levenscyclus token

- API-referenties genereren toegangstokens die 60 minuten geldig zijn.

- Het verificatieproces maakt gebruik van de stroom OAuth 2.0-clientreferenties.

- In omgevingen met meerdere organisaties of serviceproviders kunnen API-referenties van de bovenliggende organisatie toegangstokens genereren met dezelfde scopes voor een opgegeven onderliggende organisatie tijdens de autorisatie.

Documentatie en middelen

- Toegang tot uitgebreide instructies en use case documentatie.

- Elke API use case wordt gedocumenteerd onder API Reference.

- Alle eindpunten en parameters worden vermeld in de OpenAPI-specificatie, gekoppeld aan de onderkant van elk use case-overzicht.

- Als u Legacy Umbrella API's gebruikt, raadpleegt u de API-migratiegids.

- Gebruik de Postman Collection voor de Umbrella API voor de eerste tests.

- Ontdek extra bronnen, leerlabs en een Sandbox voor API-tests in de sectie Cloud Security van de ontwikkelaarspagina van Cisco.

steunen

Voor vragen of aanvullende hulp met de Umbrella API, neem contact op met Umbrella support.