Sommario

Introduzione

Panoramica dell'API Umbrella

Endpoint e gestione API

Casi di utilizzo API e gruppi di endpoint

Accesso alla chiave API e scadenza

Autenticazione e ciclo di vita dei token

Documentazione e risorse

Supporto

Introduzione

Questo documento descrive le funzionalità, le opzioni di configurazione e le risorse disponibili per la piattaforma Umbrella API.

Panoramica dell'API Umbrella

La piattaforma Umbrella API fornisce un ambiente sicuro per la creazione, l'estensione e l'integrazione con Umbrella. L'API consente di creare flussi di lavoro multipiattaforma che aggregano l'intelligence delle minacce con altre soluzioni di sicurezza per aumentare l'applicazione delle normative, aumentare la visibilità e automatizzare la risposta alle richieste di assistenza.

Endpoint e gestione API

- Tutti gli endpoint API Umbrella sono ospitati inapi.umbrella.com.

- Gli endpoint vengono raggruppati in base allo Use Case, ciascuno con un percorso specifico.

- Gestire le chiavi API nel dashboard Umbrella in Amministrazione > chiavi API o a livello di codice utilizzando l'API KeyAdmin.

Casi di utilizzo API e gruppi di endpoint

Configurare ciascuna chiave API con ambiti granulari raggruppati in questi casi di utilizzo principali:

- Endpoint API di amministrazione: Provisioning e gestione di chiavi e utenti API, visualizzazione dei ruoli e gestione dei clienti per provider e provider gestiti.

- Endpoint API di autenticazione: Autorizza integrazioni tra Umbrella e altri servizi.

- Endpoint API distribuzioni: Provisioning, monitoraggio e gestione di reti ed entità, proteggendo le reti e le entità configurandole nei criteri Umbrella esistenti.

- Endpoint API criteri: Eseguire il provisioning e gestire gli elenchi di destinazione e le destinazioni per elenco.

- Analizza endpoint API: Ricerca di domini, indirizzi IP e URL osservati dai resolver Umbrella.

- Endpoint API di report: Leggere e controllare le informazioni sulla sicurezza in tempo reale relative alle distribuzioni. L'API di individuazione applicazioni fornisce informazioni dettagliate sulle applicazioni basate su cloud.

Accesso alla chiave API e scadenza

- Impostare il livello di accesso per ogni ambito su Lettura/scrittura o Sola lettura in base all'utilizzo previsto.

- Configurare le chiavi API in modo che scadano in una data predefinita in base alle esigenze.

15143392160916

Autenticazione e ciclo di vita dei token

- Le credenziali API generano token di accesso validi per 60 minuti.

- Il processo di autenticazione utilizza il flusso di credenziali del client OAuth 2.0.

- In ambienti con più organizzazioni o provider di servizi, le credenziali API dell'organizzazione padre possono generare token di accesso con gli stessi ambiti per un'organizzazione figlio specificata durante l'autorizzazione.

Documentazione e risorse

- Accedere a istruzioni complete e alla documentazione del caso di utilizzo.

- Ciascun caso di utilizzo dell'API è documentato in API Reference.

- Tutti gli endpoint e i parametri sono elencati nella specifica OpenAPI, collegata in fondo alla panoramica di ogni use case.

- Se si utilizzano API Umbrella legacy, consultare la guida alla migrazione delle API.

- Utilizzare la raccolta Postman per l'API Umbrella per il test iniziale.

- Esplora altre risorse, i laboratori di apprendimento e una sandbox per il test delle API nella sezione Cloud Security della pagina per sviluppatori Cisco.

Supporto

Per domande o ulteriore assistenza sull'API Umbrella, contattare il supporto Umbrella.