Customer - Cloud Security API

{"type":"model","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/77649db0-b5f6-3157-b85b-a889624baad4","info":{"title":"Cisco Umbrella Providers API","version":"2.0.0","description":"Manage the customers for a provider.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Providers"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/admin/providers-overview.md","uri":"umbrella-api-reference-providers-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"admin/v2"}}}],"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"}}}}}},"spec":{"type":"object","description":"The properties of a customer.","required":["customerId","customerName","packageName","packageId","seats","streetAddress","city","countryCode","adminEmails"],"properties":{"customerId":{"type":"integer","description":"The ID for the customer.","example":1233,"$$ref":"#/components/schemas/customerId"},"customerName":{"type":"string","description":"The name of the customer's organization.","minLength":1,"maxLength":255,"example":"NameOfCustomer","$$ref":"#/components/schemas/customerName"},"licenseType":{"type":"string","description":"The type of license for the customer's organization.","example":"SIG Essentials"},"packageName":{"type":"string","enum":["Umbrella Professional","Umbrella Platform","Umbrella Insights","Cisco Umbrella for Wireless LAN","Cisco Umbrella for EDU","Umbrella DNS Security Essentials","Umbrella DNS Security Advantage","Umbrella SIG Essentials","Umbrella SIG Advantage","Umbrella Not for Resale (NFR) MSP DNS Advantage"],"description":"The name of the Umbrella package.\nTo create or update a customer with either the SIG Essentials or SIG Advantage package, you must have a license for the selected package.\n| Package Id | Package Name |\n|:----------:|----------------------------------|\n| `99` | Umbrella Professional |\n| `101` | Umbrella Platform |\n| `107` | Umbrella Insights |\n| `171` | Cisco Umbrella for Wireless LAN |\n| `202` | Cisco Umbrella for EDU |\n| `246` | Umbrella DNS Security Essentials |\n| `248` | Umbrella DNS Security Advantage |\n| `250` | Umbrella SIG Essentials |\n| `252` | Umbrella SIG Advantage |\n| `312` | Umbrella Not for Resale (NFR) MSP DNS Advantage |\n\nNote: The Umbrella NFR MSP DNS Advantage package (`312`) is only available in the Umbrella Secure MSP console.","example":"Umbrella SIG Advantage","$$ref":"#/components/schemas/packageName"},"seats":{"type":"integer","minimum":1,"description":"The number of users.","example":50,"$$ref":"#/components/schemas/seats"},"streetAddress":{"type":"string","description":"The street address for the customer.","minLength":1,"maxLength":255,"example":"One Penn Plaza","$$ref":"#/components/schemas/streetAddress"},"streetAddress2":{"type":"string","description":"The second street address for the customer.","minLength":1,"maxLength":255,"example":"Two Center Way","$$ref":"#/components/schemas/streetAddress2"},"city":{"type":"string","description":"The name of the city where the customer's organization is located.","minLength":1,"maxLength":255,"example":"Culver City","$$ref":"#/components/schemas/city"},"state":{"type":"string","description":"The name of the customer's state.","minLength":1,"maxLength":50,"example":"NY","$$ref":"#/components/schemas/state"},"countryCode":{"type":"string","description":"The country code of the customer's organization.","minLength":2,"maxLength":3,"example":"FR","$$ref":"#/components/schemas/countryCode"},"zipCode":{"type":"string","description":"The zip code of the customer's organization.","minLength":1,"example":"08105","$$ref":"#/components/schemas/zipCode"},"packageId":{"type":"integer","enum":[99,101,107,171,202,246,248,250,252,312],"description":"The ID of the Umbrella package.\nTo create or update a customer with either the SIG Essentials or SIG Advantage package, you must have a license for the selected package.\n| Package Id | Package Name |\n|:----------:|----------------------------------|\n| `99` | Umbrella Professional |\n| `101` | Umbrella Platform |\n| `107` | Umbrella Insights |\n| `171` | Cisco Umbrella for Wireless LAN |\n| `202` | Cisco Umbrella for EDU |\n| `246` | Umbrella DNS Security Essentials |\n| `248` | Umbrella DNS Security Advantage |\n| `250` | Umbrella SIG Essentials |\n| `252` | Umbrella SIG Advantage |\n| `312` | Umbrella Not for Resale (NFR) MSP DNS Advantage |\n\nNote: The Umbrella NFR MSP DNS Advantage package (`312`) is only available in the Umbrella Secure MSP console.","example":252,"$$ref":"#/components/schemas/packageId"},"dealId":{"type":"string","description":"The deal ID.","example":"14a","$$ref":"#/components/schemas/dealId"},"adminEmails":{"type":"array","description":"The list of the administrator email addresses.","items":{"type":"string","format":"email","example":"name@bbctech.com"},"example":["name@acmetech.com"],"$$ref":"#/components/schemas/adminEmails"},"ccwDealOwnerEmails":{"type":"array","description":"The list emails for the CCW deal owner.","items":{"type":"string","format":"email"},"example":["dealowner@acmetech.com"],"$$ref":"#/components/schemas/ccwDealOwnerEmails"},"createdAt":{"type":"string","format":"iso-date-time","description":"The time when the customer information was created.\nThe timestamp is specified in the ISO 8601 format.","example":"2022-10-03 13:42:39"},"modifiedAt":{"type":"string","format":"iso-date-time","description":"The time when the customer information was last modified.\nThe timestamp is specified in the ISO 8601 format.","example":"2022-11-03 13:42:39"},"isTrial":{"type":"boolean","default":true,"description":"Specify whether the customer is a trial with an MSSP with SPLA (MSLA) license.","example":true},"addonRbi":{"type":"string","description":"Specify whether remote browser isolation (RBI) is added to the subscription.\nRemote Browser Isolation Add-On is applicable for SIG Essentials or SIG Advantage only:\n `0` = No selection\n `1` = RBI Isolate Risky\n `2` = RBI Isolate Web Applications\n `3` = RBI Isolate All\n","example":"1"},"addonDlp":{"type":"boolean","description":"Specify whether data loss prevention (DLP) is added to the subscription.\nThe Data Loss Prevention Add-On is applicable only for SIG E.","example":true},"addonCdfwL7":{"type":"boolean","description":"Specify whether if cloud delivered firewall (CDFW) is added to the subscription.\nThe L7 Cloud Delivered Firewall Solution is applicable only for SIG E.","example":true}},"example":{"customerId":2345892,"customerName":"name of customer","packageId":252,"packageName":"Umbrella SIG Advantage","seats":25,"adminEmails":["name@cisco.com","name-one@cisco.com"],"streetAddress":"123 Circle Street","city":"San Jose","state":"CA","countryCode":"US","zipCode":"01904"},"$$ref":"#/components/schemas/Customer","title":"Customer"}}