Umbrella Service Providers API: create a customer

Service Providers

The Umbrella Service Providers API includes:

Service Providers (/serviceproviders)
Managed Services Providers (MSPs) (/msps)

Service Providers: Create a Customer

Create a customer using a service provider ID.

POST /serviceproviders/{serviceProviderId}/customers

Request Body Fields

Name	Type	Description
customerName	string	The customer organization name. Required
licenseType	string	The customer organization license type (applicable only for MSSP): `term` = term customer, `msla` = Managed Services License Agreement (MSLA) customer. The default value is `term`.
isTrial	boolean	Applicable only for MSSP with SPLA (MSLA) licensing. The default value is `true`.
seats	integer	The number of users. Required
streetAddress	string	The first street address. Required
streetAddress2	string	The second street address.
city	string	The name of a city. Required
state	string	The name of a state.
countryCode	string	The two character country code. Required
zipCode	string	The zipcode.
packageId	integer	For more information, see Package ID. Required
dealId	string	The deal id.
adminEmails	array	An array of admin emails. Required
ccwDealOwnerEmails	array	An array of CCW deal owner emails.
addonRbi	string	Remote Browser Isolation Add-On (applicable only for SIG E/A). Specify one of:
		`0`— No selection `1`— RBI Isolate Risky `2`— RBI Isolate Web Applications `3`— RBI Isolate All
addonCdfwL7	boolean	L7 Cloud Delivered Firewall Solution (applicable only for SIG E)
addonDlp	boolean	Data Loss Prevention Add-On (applicable only for SIG E)

Package ID Description

The package ID and name. Use the package ID in the packageId request body field.

Package ID	Package Name
`252`	Umbrella SIG Advantage
`250`	Umbrella SIG Essentials
`248`	Umbrella DNS Security Advantage
`246`	Umbrella DNS Security Essentials
`202`	Cisco Umbrella for EDU
`171`	Cisco Umbrella for Wireless LAN
`107`	Umbrella Insights
`101`	Umbrella Platform
`99`	Umbrella Professional

Request

curl -i -X POST "https://management.api.umbrella.com/v1/serviceproviders/{serviceProviderId}/customers" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json' \
-d '{
    "customerName": "newCustomer",
    "seats": 25,
    "streetAddress": "Customer street address",
    "city": "Customer city",
    "state": "Customer state",
    "countryCode": "Customer country code",
    "packageId": "Package ID",
    "adminEmails": "Adminstrative emails",
    "addonRbi": "1",
    "addonCdfwL7": true,
    "addonDlp": true
}'

Response

Sample response (200, OK):

{
    "customerId": "123",
    "customerName": "newCustomer",
    "seats": 25,
    "packageName": "Package Name",
    "packageId": "Package ID",
    "streetAddress": "Customer street address",
    "city": "Customer city",
    "state": "Customer state",
    "countryCode": "Customer country code",
    "adminEmails": "Adminstrative emails",
    "addonRbi": "1",
    "addonCdfwL7", true,
    "addonDlp", true
}

MSPs: Create a Customer

Create a customer using an MSP ID.

POST /msps/{mspId}/customers

Request Body Fields

Name	Type	Description
customerName	string	The customer organization name. Required
seats	integer	The number of users. Required

Request

curl -i -X POST "https://management.api.umbrella.com/v1/msps/{mspId}/customers" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json' \
-d '{
    "customerName": "newCustomer",
    "seats": 25
}'

Response

Sample response (200, OK):

{
    "customerId": 123,
    "customerName": "newCustomer",
    "seats": 25
}