Authentication and authorization quickstart for Cisco Umbrella for Government

Quick Start

This guide outlines the steps to create Cisco Umbrella API keys, authenticate with the Cisco Token Authorization API to obtain an access token, and then request Umbrella resources through the API. Every API operation requires a valid access token.

  1. Create your Umbrella API keys.
  2. Generate an Umbrella API Access Token
  3. Make an Umbrella API Request

Create API Keys in Umbrella

For information about creating Umbrella API keys, see Authentication.

Create API Keys with the Key Admin API

To create API keys programmatically, you can use the Umbrella Key Admin API. For more information, see Umbrella Key Admin API.

Generate an Umbrella API Access Token

The Umbrella Token Authorization API endpoint is:

POST https://api.umbrellagov.com/auth/v2/token

For more information, see Getting Started.

Request

You can use curl to create your access token. Provide your Umbrella API key and secret.

curl --user '<key>:<secret>' --request POST --url 'https://api.umbrellagov.com/auth/v2/token' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'grant_type=client_credentials'

Response

Sample response (200, OK):

{
   "token_type": "bearer",
   "access_token": "xxxxxx",
   "expires_in": 3600
}

Make an Umbrella API Request

To send a request to the Umbrella for Government API, substitute your Bearer token in the HTTP Authorization header.

In this example, your API key must include the admin key scope. For more information, see OAuth 2.0 Scopes.

For example:

curl -L --location-trusted --request GET --url 'https://api.umbrellagov.com/admin/v2/users' \
-H 'Authorization: Bearer %YourAcessToken%' \
-H 'Content-Type: application/json'