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 the
X-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.
