Cisco Umbrella Providers API
Cisco Umbrella Providers API — 16 operation(s) published by Cisco under the Cloud Security API documentation.
OpenAPI Specification
openapi: 3.0.1
info:
title: Cisco Umbrella Providers API
version: 2.0.0
description: Manage the customers for a provider.
contact:
name: Cloud Security Developer Community
x-provenance:
method: harvested
authored_by: Cisco Umbrella
harvested_by: API Evangelist
harvested_on: '2026-08-19'
first_party: true
provider_published: true
source_host: pubhub.devnetcloud.com
note: 26 first-party OpenAPI 3.0 documents (256 operations) listed by Cisco's own docs-nav config and fetched anonymously.
Byte-identity reconfirmed 2026-08-19 by SHA-256 against the live source.
x-evidence:
- type: source
url: https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/umbrella-config.json
- type: source
url: https://developer.cisco.com/docs/cloud-security/
servers:
- url: https://api.umbrella.com/{basePath}
variables:
basePath:
default: admin/v2
tags:
- name: Providers
- name: Umbrella
security:
- oauthFlow: []
paths:
/providers/customers:
post:
tags:
- Providers
- Umbrella
description: Create a customer for a provider.
summary: Create Customer for Provider
operationId: createProviderCustomer
security:
- oauthFlow:
- admin.customers:write
requestBody:
$ref: '#/components/requestBodies/CustomerCreateRequestBody'
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
$ref: '#/components/schemas/Customer'
example:
customerId: 1234
customerName: myCustomerName
licenseType: theLicenseType
packageName: Umbrella SIG Essentials
seats: 1000
streetAddress: 123 myStreet Rd.
streetAddress2: 123a mystreet2 Place
city: myCity
state: CA
countryCode: 12a
zipCode: 12345a
packageId: 101
dealId: myDealId
adminEmails:
- you@myeamil.com
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
get:
tags:
- Providers
- Umbrella
description: List the customers for the provider.
operationId: listProviderCustomers
summary: List Customers for Provider
security:
- oauthFlow:
- admin.customers:read
parameters:
- $ref: '#/components/parameters/limitParam'
- $ref: '#/components/parameters/pageParam'
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
type: array
description: List the customers for the provider.
items:
$ref: '#/components/schemas/Customer'
example:
- customerId: 1234
customerName: myCustomerName
licenseType: theLicenseType
packageName: Umbrella SIG Essentials
seats: 1000
streetAddress: 123 myStreet Rd.
streetAddress2: 123a mystreet2 Place
city: myCity
state: CA
countryCode: 12a
zipCode: 12345a
packageId: 101
dealId: myDealId
adminEmails:
- you@myeamil.com
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
/providers/customers/{customerId}:
get:
tags:
- Providers
- Umbrella
description: Get a customer for the provider.
summary: Get Customer for Provider
operationId: getProviderCustomer
security:
- oauthFlow:
- admin.customers:read
parameters:
- $ref: '#/components/parameters/customerIdParam'
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
$ref: '#/components/schemas/Customer'
example:
customerId: 1234
customerName: myCustomerName
licenseType: theLicenseType
packageName: Umbrella SIG Essentials
seats: 1000
streetAddress: 123 myStreet Rd.
streetAddress2: 123a mystreet2 Place
city: myCity
state: CA
countryCode: 12a
zipCode: 12345a
packageId: 101
dealId: myDealId
adminEmails:
- you@myeamil.com
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
delete:
tags:
- Providers
- Umbrella
description: Delete a customer for a provider.
operationId: deleteProviderCustomer
summary: Delete Customer for Provider
security:
- oauthFlow:
- admin.customers:write
parameters:
- $ref: '#/components/parameters/customerIdParam'
responses:
'204':
description: No Content
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
type: string
nullable: true
example: null
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
put:
tags:
- Providers
- Umbrella
description: Update a customer for a provider.
operationId: updateProviderCustomer
summary: Update Customer for Provider
security:
- oauthFlow:
- admin.customers:write
parameters:
- $ref: '#/components/parameters/customerIdParam'
requestBody:
$ref: '#/components/requestBodies/CustomerUpdateRequestBody'
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
$ref: '#/components/schemas/Customer'
example:
customerId: 1234
customerName: myCustomerName
licenseType: theLicenseType
packageName: Umbrella SIG Essentials
seats: 1000
streetAddress: 123 myStreet Rd.
streetAddress2: 123a mystreet2 Place
city: myCity
state: CA
countryCode: 12a
zipCode: 12345a
packageId: 101
dealId: myDealId
adminEmails:
- you@myeamil.com
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
/providers/customers/{customerId}/trialconversions:
put:
tags:
- Providers
- Umbrella
description: Convert your Managed Services License Agreement (MSLA) trial to an MSLA customer.
summary: Update Trial to Customer
operationId: putTrialConversions
security:
- oauthFlow:
- admin.customers:write
parameters:
- $ref: '#/components/parameters/customerIdParam'
requestBody:
description: Umbrella package ID
content:
application/json:
schema:
type: object
required:
- packageId
properties:
packageId:
$ref: '#/components/schemas/packageIdTrialConversions'
example:
packageId: 107
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
type: object
description: Convert an MSLA trial to an MSLA customer.
properties:
conversionStatus:
type: string
description: The status of the trial conversion.
example: success
required:
- conversionStatus
example:
conversionStatus: success
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
/providers/customers/{customerId}/accessRequests:
post:
tags:
- Providers
- Umbrella
description: Create the access request for the customer's organization.
summary: Create Customer Access Request
operationId: createCustomerAccessRequest
security:
- oauthFlow:
- admin.customers:write
parameters:
- $ref: '#/components/parameters/customerIdParam'
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
$ref: '#/components/schemas/AccessRequest'
example:
id: 1234567
organizationId: 2344568
state: approved
organizationName: test-organization
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
/providers/customers/{customerId}/accessRequests/{accessRequestId}:
get:
tags:
- Providers
- Umbrella
description: Get the access request details for the customer's organization.
summary: Get Customer Access Request
operationId: getCustomerAccessRequest
security:
- oauthFlow:
- admin.customers:read
parameters:
- $ref: '#/components/parameters/customerIdParam'
- $ref: '#/components/parameters/accessRequestIdParam'
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
$ref: '#/components/schemas/AccessRequest'
example:
id: 1234567
organizationId: 2344568
state: approved
organizationName: test-organization
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
put:
tags:
- Providers
- Umbrella
description: Update the access request for the customer's organization.
summary: Update Customer Access Request
operationId: updateCustomerAccessRequest
security:
- oauthFlow:
- admin.customers:write
parameters:
- $ref: '#/components/parameters/customerIdParam'
- $ref: '#/components/parameters/accessRequestIdParam'
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
$ref: '#/components/schemas/AccessRequest'
example:
id: 1234567
organizationId: 2344568
state: approved
organizationName: test-organization
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
/providers/customers/{customerId}/trialExtensions:
post:
tags:
- Providers
- Umbrella
description: Create the extension for the customer's trial.
summary: Create Customer Trial Extensions
operationId: createCustomerTrialExtensions
security:
- oauthFlow:
- admin.customers:write
parameters:
- $ref: '#/components/parameters/customerIdParam'
requestBody:
description: Provide the trial extension information.
content:
application/json:
schema:
type: object
description: The trial extension information.
properties:
trialExtensionDays:
type: integer
description: The number of days to extend the trial.
enum:
- 7
- 14
example:
trialExtensionDays: 7
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
$ref: '#/components/schemas/GetCustomer'
example:
organizationId: 2345892
organizationTypeId: 4
originId: 2345964
organizationName: organization name
createdAt: 1594557263
modifiedAt: 1667252442
subscriptionId: 1678934
packageId: 250
packageName: Umbrella SIG Essentials
packageInternalName: SIG Essentials
users: 25
startsAt: '2023-03-01'
endsAt: '2023-07-01'
strength:
customerLoggedIn: true
lastLoginDate: '2022-10-03 13:42:39'
identitiesCreated: 12
hasTraffic: false
trialStrength: High
adminEmails:
- name@cisco.com
- name-one@cisco.com
streetAddress: 123 Circle Street
streetAddress2: P.O. Box 575
city: San Jose
state: CA
countryCode: US
zipCode: 01904
dealId: 123443c
ppovLifecycle:
state: state of customer trial
date: '2023-02-28'
enabled: true
lastSentDate: '2023-03-01'
mailIdentifiers:
noLoginDayFourMailIdentifier: customer email identifier, no login four days
noOriginDayThreeMailIdentifier: three day email identifier, no origin
noOriginDaySevenMailIdentifier: seven day email identifer, no origin
excludedLifecycleEmails:
- name@acmeTech.com
hasDistributorVisibility: true
isOnboardingWizardCompleted: true
trialId: MD5 hash
accountManagerEmails:
- name@cisco.com
- name-one@cisco.com
accessRequestId: 1234565
accessRequestState: pending
trialPeriod: Aug 18, 2022 - Oct 15, 2023
trialExtensionCount: 3
trialExtendedDays: 10
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
/providers/customers/{customerId}/subscriptionDetails:
get:
tags:
- Providers
- Umbrella
description: Get the subscription details for the customer's organization.
summary: Get Customer Subscription Details
operationId: getCustomerSubscriptionDetails
security:
- oauthFlow:
- admin.customers:read
parameters:
- $ref: '#/components/parameters/customerIdParam'
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
$ref: '#/components/schemas/GetCustomer'
example:
organizationId: 2345892
organizationTypeId: 4
originId: 2345964
organizationName: organization name
createdAt: 1594557263
modifiedAt: 1667252442
subscriptionId: 1678934
packageId: 250
packageName: Umbrella SIG Essentials
packageInternalName: SIG essentials
users: 25
startsAt: '2023-03-01'
endsAt: '2023-07-01'
strength:
customerLoggedIn: true
lastLoginDate: '2022-10-03 13:42:39'
identitiesCreated: 12
hasTraffic: false
trialStrength: High
adminEmails:
- name@cisco.com
- name-one@cisco.com
streetAddress: 123 Circle Street
streetAddress2: P.O. Box 575
city: San Jose
state: CA
countryCode: US
zipCode: 01904
dealId: 123443c
ppovLifecycle:
state: state of customer trial
date: '2023-02-28'
enabled: true
lastSentDate: '2023-03-01'
mailIdentifiers:
noLoginDayFourMailIdentifier: customer email identifier, no login four days
noOriginDayThreeMailIdentifier: three day email identifier, no origin
noOriginDaySevenMailIdentifier: seven day email identifer, no origin
excludedLifecycleEmails:
- name@acmeTech.com
hasDistributorVisibility: true
isOnboardingWizardCompleted: true
trialId: MD5 hash
accountManagerEmails:
- name@cisco.com
- name-one@cisco.com
accessRequestId: 1234565
accessRequestState: pending
trialPeriod: Aug 18, 2022 - Oct 15, 2023
trialExtensionCount: 3
trialExtendedDays: 10
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
/providers/customers/{customerId}/trialStrengths:
get:
tags:
- Providers
- Umbrella
description: Get the strength of a customer trial for a provider.
summary: Get Customer Trial Strength
operationId: getCustomerTrialStrength
security:
- oauthFlow:
- admin.customers:read
parameters:
- $ref: '#/components/parameters/customerIdParam'
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
$ref: '#/components/schemas/TrialStrength'
example:
customerLoggedIn: true
lastLoginDate: '2022-10-03 13:42:39'
identitiesCreated: 25
hasTraffic: false
trialStrength: '-'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
/providers/customerAddresses:
get:
tags:
- Providers
- Umbrella
description: Get the customer addresses for provider.
summary: Get Customer Addresses for Provider
operationId: getCustomerAddresses
security:
- oauthFlow:
- admin.customerSearch:read
parameters:
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/limitParam'
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomerAddress'
example:
- accountId: 132405632
accountSiteId: 104571945
mappedCrPartyId: 10803658
organizationName: cisco
streetAddress: 73 Rue De La Plain
streetAddress2: 213 Circle Ct
city: San Jose
state: CA
countryCode: US
zipCode: '75020'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
/providers/customers/packages:
get:
tags:
- Providers
- Umbrella
description: Get the packages for the trial customer.
summary: Get Customer Packages for Provider
operationId: getCustomerPackages
security:
- oauthFlow:
- admin.customers:read
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Package'
example:
- id: 246
name: Umbrella DNS Security Essentials
pkgSeatMin: 1
ppovSeatMin: 1
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
/providers/customerDeals/{dealId}:
get:
tags:
- Providers
- Umbrella
description: Get the information about deals available to customer.
summary: Get Customer Deals by ID
operationId: getCustomerDeals
parameters:
- $ref: '#/components/parameters/dealIdParam'
- $ref: '#/components/parameters/ccoIdParam'
security:
- oauthFlow:
- admin.customerDeals:read
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomerDeal'
example:
- dealId: 1233456a
endCustomer: ''
majorLineItems:
- objectId: 12345345
sourceAppRefId: abdjlkjfkj22
canStampDeal: true
trialIds:
- abbfyue458cjd
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
put:
tags:
- Providers
- Umbrella
description: Update the customer deal.
summary: Update Customer Deals by ID
operationId: updateCustomerDeals
security:
- oauthFlow:
- admin.customerDeals:write
parameters:
- $ref: '#/components/parameters/dealIdParam'
requestBody:
description: Provide the customer deal information.
content:
application/json:
schema:
type: object
required:
- ccoid
- customerId
properties:
ccoid:
type: integer
format: int32
example: 12329433
description: The ID of the user querying the deal ID.
customerId:
$ref: '#/components/schemas/customerId'
quoteId:
type: integer
format: int32
example: 8484
description: The ID for the quote.
majorLineItems:
type: array
items:
type: object
properties:
objectId:
type: integer
format: int32
example: 12345
sourceAppRefId:
type: string
example: abbfyue458cjd
example:
ccoid: 123435
customerId: 1234
quoteId: 23423
majorLineItems:
- objectId: 12345345
sourceAppRefId: abdjlkjfkj22
responses:
'200':
description: OK
headers:
Content-Type:
$ref: '#/components/headers/Content-Type'
Date:
$ref: '#/components/headers/Date'
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerDeal'
example:
dealId: 1233456a
endCustomer: ''
majorLineItems:
- objectId: 12345345
sourceAppRefId: abdjlkjfkj22
canStampDeal: true
trialIds:
- abbfyue458cjd
'400':
$ref: '#/components/responses/400ErrorPutCustomerDeals'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'500':
$ref: '#/components/responses/500Error'
components:
securitySchemes:
oauthFlow:
type: oauth2
description: The client credential flow.
flows:
clientCredentials:
tokenUrl: https://api.umbrella.com/auth/v2/token
scopes:
admin.customers:read: Read admin customers
admin.customers:write: Write admin customers
admin.customerSearch:read: Read admin customer search
admin.customerDeals:read: Read admin customer deals
admin.customerDeals:write: Write admin customer deals
headers:
Date:
schema:
type: string
format: iso-date-time
description: 'The date and time of the request that is represented in ISO 8601 format.
The timestamp uses Greenwich Mean Time (GMT).'
example: 'Date: Mon, 18 Apr 2022 11:11:11 GMT'
Content-Type:
schema:
type: string
description: The MIME content type of the response body.
example: application/json
parameters:
customerIdParam:
name: customerId
in: path
description: The ID of the customer.
required: true
schema:
type: integer
format: int32
accessRequestIdParam:
name: accessRequestId
in: path
description: The access request ID.
required: true
schema:
type: integer
pageParam:
name: page
in: query
description: A number of a page in the collection.
schema:
type: integer
default: 1
format: int32
minimum: 1
required: false
example: 2
limitParam:
name: limit
in: query
description: The number of records to return from the collection on a page.
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 100
example: 50
dealIdParam:
name: dealId
in: path
description: The deal ID.
required: true
schema:
type: string
example: 1235a
ccoIdParam:
name: ccoId
in: query
description: The ID of the user querying the deal ID.
required: true
schema:
type: integer
format: int32
example: 12329433
requestBodies:
CustomerCreateRequestBody:
description: Create a new customer with the provided information.
content:
application/json:
schema:
type: object
description: Create a new customer with the provided information.
required:
- customerName
- seats
- streetAddress
- city
- countryCode
- packageId
- adminEmails
properties:
customerName:
$ref: '#/components/schemas/customerName'
addonRbi:
type: string
enum:
- '0'
- '1'
- '2'
- '3'
maxLength: 1
d
# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-umbrella/refs/heads/main/openapi/cisco-umbrella-admin-providers-openapi.yml