Manage Child Organizations with Umbrella APIs Using X-Umbrella-OrgID

Available Languages

Download Options

PDF (93.9 KB)
View with Adobe Reader on a variety of devices
ePub (163.0 KB)
View in various apps on iPhone, iPad, Android, Sony Reader, or Windows Phone
Mobi (Kindle) (133.9 KB)
View on Kindle device or Kindle app on multiple devices

Updated:October 22, 2025

Document ID:225251

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Introduction

This document describes how a parent organization can manage child organizations with Umbrella APIs using the X-Umbrella-OrgID header.

Overview

A parent organization can manage child organizations in Umbrella APIs in two ways:

By creating API keys on behalf of each child organization and using those keys for API requests (either in theUIorprogrammatically).
By making direct API requests on behalf of each child organization using a single parent org API key.

For example, a central office (parent org) can generate a global security report that includes event data from all branch offices (child orgs) by making API requests for each branch and combining their event information.

Make API Requests on Behalf of Child Organizations

To make API requests for a child organization:

The central office administrator creates an API key in the parent organization.
When making an API request, add theX-Umbrella-OrgIDheader with the child organization’s OrgID.
Use the access token from the parent org API key to authenticate the request.

Example:
To generate a combined security event report for multiple branches, the central office makes API calls for each branch office, using the correct X-Umbrella-OrgID header for each request.