Umbrella Users and Roles API

Users and Roles

The Umbrella Users and Roles API endpoints enable you to create and manage user accounts, list the Umbrella roles for your organization, reset passwords for a child (customer) organization in your managed organizations, and get information about your managed organizations. You can find the Umbrella Users and Roles API endpoint under the admin scope in the Umbrella API.

Note: The /passwordResets/{customerId} and /organizations API endpoints are only available for parent (provider) organizations on the Multi-org or provider console. Only the parent organization's API credentials can generate an API access token that can authorize the /passwordResets/{customerId} and /organizations API requests. A child (customer) organization of the parent (provider) organization does not have permission to access the /passwordResets/{customerId} or /organizations API endpoints. For the /passwordResets/{customerId} API endpoint, set a child organization ID in the customerId path parameter.

Rate Limits for Admin API Endpoints

Umbrella enables rate limits on the Users and Roles API endpoints. For more information, see Rate Limits > Admin.

Request Headers

Unless specified, the Umbrella API endpoints use JSON for all requests and responses.

Note: For POST, PUT, and PATCH operations, set the HTTP Content-Type header to application/json in your API request.

Users and Roles API Endpoints