Umbrella API Authentication

Authentication

The Umbrella API provides a standard REST interface and supports the OAuth 2.0 client credentials flow. To get started, log in to Umbrella and create an Umbrella API key.

Note: API keys, passwords, secrets, and tokens allow access to your private customer data. Never share your credentials with another user or organization.

Prerequisites

You must have an Umbrella user account with the Full Admin role.

Log in to Umbrella

https://dashboard.umbrella.com

You can find your username after Admin in the navigation tree. Confirm that your organization appears under your username.

API Key Use Cases

You can create various types of API key. The Umbrella Key Admin API enables you to provision and manage Umbrella API keys. Use your Umbrella API keys or legacy Umbrella API keys to create and manage network entities and users, access your reports, manage policies, and integrate your systems and devices with the Cisco Cloud Security platform.

Key Type	Description	Use Cases
Umbrella API key	Secure, intent-based API key with configured scopes and expiration date.	View and manage your deployments, users, and policies. View reports and logs.
Legacy Umbrella API key	API key that supports access to multiple API resources using Basic authentication. For more information, see Authentication.	View and manage your deployments, users, and policies. View reports and logs.
Umbrella Key Admin API key	Secure API key with configured permissions and expiration date.	View and manage the Umbrella API keys in your organization.

Manage API Keys

Create and manage Umbrella API keys.

Create Umbrella API Key

Create an Umbrella API key ID and key secret.

Note: You have only one opportunity to copy your API secret. Umbrella does not save your API secret and you cannot retrieve the secret after its initial creation.

Navigate to Admin > API Keys or in a Multi-org, Managed Service Provider (MSP), or Managed Secure Service Provider (MSSP) console navigate to Console Settings > API Keys.
Click API Keys and then click Add.
- The number of expired API keys appears next to the red triangle.
- The number of API keys that expire within 30 days appears next to the yellow triangle.
Enter a name and description for the key. A name must contain fewer than 256 characters. The description is optional.
Check the key scopes and expand a key scope to view the scope categories. Check each scope category in a key scope to enable access to the API endpoints. For information about the Umbrella API key scopes, see OAuth 2.0 Scopes.
Choose Read-Only or Read / Write for the selected scope and resource.
For Expiry Date, choose the expiration date for the key, or choose Never expire.
(Optional) For Network Restrictions, enter a comma-separated list of public IP addresses or CIDRs, then click ADD.

Note: You can add up to ten networks to your API key. You can only use your API key to authenticate requests for clients on the selected networks.
Click Create Key.
Copy and save your API Key and Key Secret.
Click Accept And Close.

Refresh Umbrella API Key

Refresh an Umbrella API key ID and key secret.

Note: You have only one opportunity to copy your API secret. Umbrella does not save your API secret and you cannot retrieve the secret after its initial creation.

Navigate to Admin > API Keys or in a Multi-org, Managed Service Provider (MSP), or Managed Secure Service Provider (MSSP) console, navigate to Console Settings > API Keys.
Click API Keys, and then expand an API key.
Click Refresh Key.
Copy and save your API Key and Key Secret.
Click Accept and Close.

Update Umbrella API Key

Update an Umbrella API key.

Navigate to Admin > API Keys or in a Multi-org, Managed Service Provider (MSP), or Managed Secure Service Provider (MSSP) console, navigate to Console Settings > API Keys.
Click API Keys, and then expand an API key. You can modify the API Key Name, Description, selected scopes and permissions in Key Scope, and Expiry Date.
For Network Restrictions, update the list of IP addresses and CIDRs. Click on the X to remove a network address.
Click Save.

Delete Umbrella API Key

Delete an Umbrella API key.

Navigate to Admin > API Keys or in a Multi-org, Managed Service Provider (MSP), or Managed Secure Service Provider (MSSP) console, navigate to Console Settings > API Keys.
Click API Keys, and then expand an API key.
Click Delete. In the dialog window, click Delete to remove the API key from your organization.

Manage Key Admin API Keys

Create and manage Umbrella Key Admin API keys.

Create Key Admin Key

Create a Key Admin API key and secret.

Note: You have only one opportunity to copy your API secret. Umbrella does not save your API secret and you cannot retrieve the secret after its initial creation.

Navigate to Admin > API Keys or in a Multi-org, Managed Service Provider (MSP), or Managed Secure Service Provider (MSSP) console navigate to Console Settings > API Keys.
Click KeyAdmin Keys, and then click Add.
- The number of expired API keys appears next to the red triangle.
- The number of API keys that expire within 30 days appears next to the yellow triangle.
Enter a name and description for the key. A name must contain fewer than 256 characters. The description is optional.
Check the permissions for the key.
For Expiry Date, choose the expiration date for the key, or choose Never expire.
(Optional) For Network Restrictions, enter a comma-separated list of public IP addresses or CIDRs, then click ADD.

Note: You can add up to ten networks to your API key. You can only use your API key to authenticate requests for clients on the selected networks.
Click Create Key.
Copy and save your KeyAdmin Key and Key Secret.
Click Accept And Close.

Refresh Key Admin Key

Refresh a Key Admin API key and secret.

Note: You have only one opportunity to copy your API secret. Umbrella does not save your API secret and you cannot retrieve the secret after its initial creation.

Navigate to Admin > API Keys or in a Multi-org, Managed Service Provider (MSP), or Managed Secure Service Provider (MSSP) console navigate to Console Settings > API Keys.
Click KeyAdmin Keys, and then expand an API key.
Click Refresh Key.
Copy and save your KeyAdmin Key and Key Secret.
Click Accept and Close.

Update Key Admin Key

Update a Key Admin API key.

Navigate to Admin > API Keys or in a Multi-org, Managed Service Provider (MSP), or Managed Secure Service Provider (MSSP) console navigate to Console Settings > API Keys.
Click KeyAdmin Keys, and then expand an API key. You can modify the Key Admin Key Name, Description, Permissions, Expiry Date, and Network Restrictions.
Click Save.

Delete Key Admin Key

Delete a Key Admin API key.

Navigate to Admin > API Keys or in a Multi-org, Managed Service Provider (MSP), or Managed Secure Service Provider (MSSP) console navigate to Console Settings > API Keys.
Click KeyAdmin Keys, and then expand an API key.
Click Delete. In the dialog window, click Delete to remove the API key from your organization.