Cisco Umbrella Providers API

The Providers API from Cisco Umbrella — 14 operation(s) for providers.

Operations 19

POST /providers/customers Create Customer for Provider #
GET /providers/customers List Customers for Provider #
GET /providers/customers/{customerId} Get Customer for Provider #
DELETE /providers/customers/{customerId} Delete Customer for Provider #
PUT /providers/customers/{customerId} Update Customer for Provider #
PUT /providers/customers/{customerId}/trialconversions Update Trial to Customer #
POST /providers/customers/{customerId}/accessRequests Create Customer Access Request #
GET /providers/customers/{customerId}/accessRequests/{accessRequestId} Get Customer Access Request #
PUT /providers/customers/{customerId}/accessRequests/{accessRequestId} Update Customer Access Request #
POST /providers/customers/{customerId}/trialExtensions Create Customer Trial Extensions #
GET /providers/customers/{customerId}/subscriptionDetails Get Customer Subscription Details #
GET /providers/customers/{customerId}/trialStrengths Get Customer Trial Strength #
GET /providers/customerAddresses Get Customer Addresses for Provider #
GET /providers/customers/packages Get Customer Packages for Provider #
GET /providers/customerDeals/{dealId} Get Customer Deals by ID #
PUT /providers/customerDeals/{dealId} Update Customer Deals by ID #
GET /providers/consoles Get Providers Console Data #
GET /providers/customers/downloadReportRequests Get Customer Security Report #
POST /providers/customers/{customerId}/securityReportRequests Create Customer Security Report Request #

Documentation

📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-admin-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-admin-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-managed-providers-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-managed-providers-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-providers-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-providers-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-s3-key-rotation-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-s3-key-rotation-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-users-roles-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-users-roles-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-authentication/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-authentication/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/cloudlock-api-getting-started/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/cloudlock-api-getting-started/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-internal-domains-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-internal-domains-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-internal-networks-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-internal-networks-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-network-devices-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-network-devices-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-network-tunnels-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-network-tunnels-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-networks-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-networks-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-deployment-policies-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-deployment-policies-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-roaming-computers-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-roaming-computers-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-sites-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-sites-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-swg-devices-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-swg-devices-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-tagging-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-tagging-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-virtual-appliances-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-virtual-appliances-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-investigate-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-investigate-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-application-lists-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-application-lists-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-destination-lists-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-destination-lists-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-api-usage-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-api-usage-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-app-discovery-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-app-discovery-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-reports-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-reports-overview/
📖
Documentation
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-reporting-overview/
📖
APIReference
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-reporting-overview/

Specifications

Other Resources

🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/admin/key-admin.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/admin/managed-providers.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/admin/providers.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/admin/s3-key-rotation.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/admin/service-providers-console.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/admin/users-roles.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/auth/token.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/cloudlock/cloudlock.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/deployments/internal-domains.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/deployments/internal-networks.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/deployments/network-devices.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/deployments/network-tunnels.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/deployments/networks.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/deployments/policies.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/deployments/roaming-computers.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/deployments/sites.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/deployments/swg-devices.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/deployments/tagging.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/deployments/virtual-appliances.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/investigate/investigate.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/policies/application-lists-internet-umb.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/policies/destination-lists.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/reports/api-usage.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/reports/app-discovery.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/reports/provider-consoles.yaml
🔗
OpenAPI Source
https://pubhub.devnetcloud.com/media/cloud-security-apis-in-eft/docs/reference/reports/reporting.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/cisco-umbrella-providers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cisco-umbrella-providers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cisco Umbrella Providers API
  version: 2.0.0
  contact:
    name: Cloud Security Developer Community
  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/
  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.
  description: 'Operations tagged Providers across 2 of this provider''s published API definitions: cisco-umbrella-admin-providers-openapi.yml, cisco-umbrella-reports-provider-consoles-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.umbrella.com/{basePath}
  variables:
    basePath:
      default: admin/v2
security:
- oauthFlow: []
tags:
- name: Providers
paths:
  /providers/customers:
    post:
      tags:
      - Providers
      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
      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'
    servers:
    - url: https://api.umbrella.com/{basePath}
      variables:
        basePath:
          default: admin/v2
  /providers/customers/{customerId}:
    get:
      tags:
      - Providers
      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
      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
                - 'null'
              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
      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'
    servers:
    - url: https://api.umbrella.com/{basePath}
      variables:
        basePath:
          default: admin/v2
  /providers/customers/{customerId}/trialconversions:
    put:
      tags:
      - Providers
      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'
    servers:
    - url: https://api.umbrella.com/{basePath}
      variables:
        basePath:
          default: admin/v2
  /providers/customers/{customerId}/accessRequests:
    post:
      tags:
      - Providers
      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'
    servers:
    - url: https://api.umbrella.com/{basePath}
      variables:
        basePath:
          default: admin/v2
  /providers/customers/{customerId}/accessRequests/{accessRequestId}:
    get:
      tags:
      - Providers
      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
      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'
    servers:
    - url: https://api.umbrella.com/{basePath}
      variables:
        basePath:
          default: admin/v2
  /providers/customers/{customerId}/trialExtensions:
    post:
      tags:
      - Providers
      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'
    servers:
    - url: https://api.umbrella.com/{basePath}
      variables:
        basePath:
          default: admin/v2
  /providers/customers/{customerId}/subscriptionDetails:
    get:
      tags:
      - Providers
      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'
    servers:
    - url: https://api.umbrella.com/{basePath}
      variables:
        basePath:
          default: admin/v2
  /providers/customers/{customerId}/trialStrengths:
    get:
      tags:
      - Providers
      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'
    servers:
    - url: https://api.umbrella.com/{basePath}
      variables:
        basePath:
          default: admin/v2
  /providers/customerAddresses:
    get:
      tags:
      - Providers
      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'
    servers:
    - url: https://api.umbrella.com/{basePath}
      variables:
        basePath:
          default: admin/v2
  /providers/customers/packages:
    get:
      tags:
      - Providers
      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'
    servers:
    - url: https://api.umbrella.com/{basePath}
      variables:
        basePath:
          default: admin/v2
  /providers/customerDeals/{dealId}:
    get:
      tags:
      - Providers
      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
      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'
    servers:
    - url: https://api.umbrella.com/{basePath}
      variables:
        basePath:
          default: admin/v2
  /providers/consoles:
    get:
      tags:
      - Providers
      description: Get the data available from the provider's console.
      summary: Get Providers Console Data
      operationId: getProvidersConsoleData
      security:
      - oauthFlow:
        - reports.customers:read
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvidersConsole'
              example:
                packageName: Umbrella SIG Essentials
                seatsTotal: 25
                seatsUsed: 20
                customerCount: 20
                status: enrolled
                rebillAt: '2022-06-13T16:07:07.222Z'
                expiresAt: '2022-06-13T16:07:07.222Z'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerErr'
    servers:
    - url: https://api.umbrella.com/{basePath}
      variables:
        basePath:
          default: reports/v2
  /providers/customers/downloadReportRequests:
    get:
      tags:
      - Providers
      description: Get the security report for the customer of the service provider.
      summary: Get Customer Security Report
      operationId: getServiceProviderCustomerSecurityReport
      security:
      - oauthFlow:
        - reports.customers:read
      parameters:
      - $ref: '#/components/parameters/outputFormatParam'
      responses:
        '200':
          description: OK

# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-umbrella/refs/heads/main/openapi/cisco-umbrella-providers-api-openapi.yml