The Umbrella Documentation Hub

Welcome to the Umbrella documentation hub. Here you'll find our comprehensive guides designed to help you use with Cisco Umbrella.

Get Started    

Deploy the G Suite Identity Service

The G Suite identity service feature is an enhancement to the Cisco Umbrella Chromebook client and adds the Organizational Unit (OU)-based Umbrella policy enforcement capabilities. For overview information, refer to Umbrella for G Suite Identity Service.

Known Limitations

The current release is the first to support G Suite service integration. Current limitations (listed below) are planned to be addressed in upcoming releases.

  • G Suite identities-based policy and enforcement is supported only on Chromebooks with Umbrella Chromebook client software.
  • Google OU and User information updates can take up to 15 mins to appear in the Cisco Umbrella dashboard.

Prerequisites

The following prerequisites are specific to the G Suite identity service feature. For deployment information about the Cisco Umbrella Chromebook client without the G Suite identity service, refer to the Umbrella Chromebook client deployment guide.

Umbrella Licensing

The G Suite identity service is part of these Cisco Umbrella licenses:

Enabling the G Suite Identity Service

Enabling the G Suite identity service for the Cisco Umbrella Chromebook client requires two steps:

  • Install the Cisco Umbrella Authorizer marketplace app.
  • Enter the G Suite account super administrator ID in the Cisco Umbrella dashboard by a full admin account of the Cisco Umbrella dashboard.

To use the G Suite identity service, update your config file with the G Suite flag as shown below:

{  
  "organizationInfo":{  
     "Value":{  
        "organizationId":1234567,
        "regToken":"GtTYPQfgSzQtGzYUrINmbjgTu5XriDtn"
     }
  },
  "vaIPs":{  
     "Value":[  
        "192.168.100.10",
        "192.168.100.11"
     ]
  },
  "googleDirectoryService": {
   	 "Value": true
  }
}

Install the Cisco Umbrella Authorizer App

The Cisco Umbrella Authorizer marketplace application authorizes the scopes needed by Umbrella to retrieve information from your G Suite account. Follow these steps to install the app in your Google administration console:

  1. Open your G Suite administration console, using the super administrator ID.
  2. Navigate to the app in the Google marketplace.
  1. Click Domain Install, then in the dialog that appears, click Accept.

You can review detailed information about the scopes required.

Enter your G Suite super administrator ID in the Umbrella Dashboard

  1. In Cisco Umbrella, navigate to Deployments > Chromebook Users.
  2. Click Configure. The Configure Chromebook Umbrella Clients window appears.
  1. Click Super Admin Sign In. In the window that appears, choose the super administrator account:
  1. Sign in to sync your G Suite identities with Cisco Umbrella. This can take up to 15 minutes.

The Umbrella Policies page displays two new containers: G Suite OUs and G Suite Users.


Public Session Support < Deploy the G Suite Identity Service > Configure Chromebook Policies

Deploy the G Suite Identity Service


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.