Cisco Umbrella
Visualize Cisco Umbrella networks, domains, destinations, users, and discovered applications in the JupiterOne graph. Use this integration to also map Cisco Umbrella users to employees in your JupiterOne account and to monitor changes to Cisco Umbrella entities using JupiterOne alerts.
- Installation
- Authorization
- Data Model
- Release Notes
Installation
Cisco Umbrella uses OAuth 2.0 client credentials (API Key and Key Secret) to authenticate API requests. You need access to an account with permission to create API keys. You must also have permission in JupiterOne to install new integrations.
Configuration in Cisco Umbrella
- Sign in to Cisco Umbrella and navigate to Admin > API Keys.
- Create a new API key with the following minimum scopes (all Read-Only):
- Admin — Roles, Users
- Deployments
- Policies — Destination Lists, Destinations
- Reports — App Discovery
- Record the API Key and Key Secret values.
Network Tunnel data requires an active Cisco Umbrella SIG (Secure Internet Gateway) license. If your account does not have SIG enabled, the integration will skip network tunnel ingestion and log a warning — all other data types will still be collected.
Configuration in JupiterOne
To install the Cisco Umbrella integration in JupiterOne, navigate to the Integrations tab, select Cisco Umbrella, and click New Instance.
Creating an instance requires the following:
- API Key — The Cisco Umbrella API key used for authentication.
- Key Secret — The secret associated with the API key.
You can also set an optional Description and choose a Polling Interval for how often the integration runs. Leave the polling interval as DISABLED to trigger runs manually.
Click Create to save and activate the integration.
Next steps
After creating the instance, the integration will run on the polling interval you configured and populate data in JupiterOne. See the Instance management guide for more on managing integration instances.
OAuth Scopes
OAuth scopes that must be granted to the application or service principal.
Show OAuth Scopes (12)
admin.roles:readadmin.users:readdeployments.internaldomains:readdeployments.internalnetworks:readdeployments.networkdevices:readdeployments.policies:readdeployments.sites:readdeployments.tunnels:readdeployments.virtualappliances:readpolicies.destinationLists:readpolicies.destinations:readreports.appDiscovery:read
Endpoints
API endpoints that the integration makes requests to.
Show Endpoints (13)
https://api.umbrella.com/admin/v2/roleshttps://api.umbrella.com/admin/v2/usershttps://api.umbrella.com/deployments/v2/internaldomainshttps://api.umbrella.com/deployments/v2/internalnetworkshttps://api.umbrella.com/deployments/v2/networkdeviceshttps://api.umbrella.com/deployments/v2/policieshttps://api.umbrella.com/deployments/v2/siteshttps://api.umbrella.com/deployments/v2/tunnelshttps://api.umbrella.com/deployments/v2/virtualapplianceshttps://api.umbrella.com/policies/v2/destinationlistshttps://api.umbrella.com/policies/v2/destinationlists/{destinationListId}/destinationshttps://api.umbrella.com/reports/v2/appDiscovery/applicationCategorieshttps://api.umbrella.com/reports/v2/appDiscovery/applications
Licenses
Product licenses or SKUs required in the target environment.
Show Licenses (1)
Cisco Umbrella SIG (Secure Internet Gateway)
Documentation Links
Links to provider documentation relevant to setup and configuration.
Show Documentation Links (1)
Entities
The following entities are created:
| Resources | Entity _type | Entity _class |
|---|---|---|
| Account | cisco_umbrella_account | Account |
| Application | cisco_umbrella_application | Application |
| Application Category | cisco_umbrella_application_category | Group |
| Destination | cisco_umbrella_destination | Record |
| Destination List | cisco_umbrella_destination_list | Record |
| Domain | cisco_umbrella_domain | Domain |
| Network | cisco_umbrella_network | Network |
| Network Device | cisco_umbrella_network_device | Device |
| Network Tunnel | cisco_umbrella_network_tunnel | NetworkEndpoint |
| Policy | cisco_umbrella_policy | Policy |
| Site | cisco_umbrella_site | Site |
| System Role | cisco_umbrella_role | AccessRole |
| System User | cisco_umbrella_user | User |
| Virtual Appliance | cisco_umbrella_virtual_appliance | Gateway |
Relationships
The following relationships are created:
Source Entity _type | Relationship _class | Target Entity _type |
|---|---|---|
cisco_umbrella_account | HAS | cisco_umbrella_application |
cisco_umbrella_account | HAS | cisco_umbrella_destination_list |
cisco_umbrella_account | HAS | cisco_umbrella_network_device |
cisco_umbrella_account | HAS | cisco_umbrella_domain |
cisco_umbrella_account | HAS | cisco_umbrella_network |
cisco_umbrella_account | HAS | cisco_umbrella_policy |
cisco_umbrella_account | HAS | cisco_umbrella_site |
cisco_umbrella_account | HAS | cisco_umbrella_user |
cisco_umbrella_application | HAS | cisco_umbrella_application_category |
cisco_umbrella_destination_list | HAS | cisco_umbrella_destination |
cisco_umbrella_site | HAS | cisco_umbrella_network_tunnel |
cisco_umbrella_site | HAS | cisco_umbrella_virtual_appliance |
cisco_umbrella_user | ASSIGNED | cisco_umbrella_role |
cisco_umbrella_virtual_appliance | USES | cisco_umbrella_domain |