{"type":"model","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/83e8a10367d157243cd1c3e478b807cb81262a3d/820fcafe-b182-32fa-a453-9975f795ce70","info":{"title":"Providers Console Report","version":"2.0.0","description":"Providers Console Report","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Providers"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/reports/providers-consoles-overview.md","uri":"umbrella-api-reference-providers-consoles-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"reports/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.com/auth/v2/token","scopes":{"reports.customers:read":"Read reports customers","reports.customers:write":"Write reports customers"}}}}}},"spec":{"type":"object","required":["isReportReady"],"properties":{"isReportReady":{"type":"boolean","default":true,"description":"Specifies whether the security report is ready to download","example":false},"organizationTypeId":{"type":"integer","description":"The type ID of the customer's organization"},"organizationName":{"type":"string","description":"The name of the customer's organization"},"organizationId":{"type":"integer","description":"The ID of the customer's organization"},"createdAt":{"type":"integer","description":"The time when the report was created. Specify the time in milliseconds.","example":1594557263},"packageName":{"type":"string","description":"The name of customer's subscription"},"users":{"type":"integer","description":"The number of users in the subscription"},"adminEmails":{"type":"array","items":{"type":"string"},"description":"The emails of admins for the customer's organization"},"streetAddress":{"type":"string","description":"The customer's street address"},"streetAddress2":{"type":"string","description":"The second street address for the customer"},"city":{"type":"string","description":"The customer's city"},"state":{"type":"string","description":"The customer's state"},"countryCode":{"type":"string","description":"The customer's country","minLength":2,"maxLength":3},"zipCode":{"type":"string","description":"The customer's zip code"},"dealId":{"type":"string","description":"The ID of the CCW deal for the subscription"},"ppovLifecycle":{"type":"object","description":"The email details for a customer trial lifecycle events","properties":{"state":{"type":"string","description":"The current state of the customer trial"},"date":{"type":"string","format":"date","description":"","example":"2021-09-28"},"enabled":{"type":"boolean","description":"Specify whether lifecycle emails are enabled"},"lastSentDate":{"type":"string","format":"date","description":"Specify last lifecycle email sent date","example":"2021-10-05"},"mailIdentifiers":{"type":"object","description":"The information about the email identifiers for the customer","properties":{"noLoginDayFourMailIdentifier":{"type":"string","description":"The email for the customer that did not log in for four days","example":"name@noorgin.acmetech.com"},"noOriginDayThreeMailIdentifier":{"type":"string","description":"The email for the customer that has not set up an origin for three days","example":"name@noorgin.acmetech.com"},"noOriginDaySevenMailIdentifier":{"type":"string","description":"The email for the customer that has not set up an origin for seven days","example":"name@noorgin.acmetech.com"}}},"excludedLifecycleEmails":{"type":"array","items":{"type":"string"},"description":"The emails excluded for the lifecycle of the customer","example":["name1@acmeTech.com","name2@acmetech.com"]}},"$$ref":"#/components/schemas/PpovLifecycle"},"hasDistributorVisibility":{"type":"boolean","description":"Specify whether the distributor has visibility into the trial"},"isOnboardingWizardCompleted":{"type":"boolean","description":"Specify whether customer has logged into the dashboard"},"trialId":{"type":"string","description":"The MD5 value of the customer's trial ID"},"accountManagerEmails":{"type":"array","items":{"type":"string"},"description":"The emails of the account managers"},"trialStartsAt":{"type":"string","format":"date","description":"The start date of the trial subscription","example":"2021-09-22"},"trialEndsAt":{"type":"string","format":"date","description":"The end date of the trial subscription","example":"2021-11-22"},"serviceGracePeriodEndDate":{"type":"integer","example":1594557263,"description":"The period that extends the trial subscription"},"networks":{"type":"integer","description":"The number of networks deployed in the customer's organization","example":25},"roamingClients":{"type":"integer","description":"The number of roaming clients deployed in the customer's organization","example":20},"VAs":{"type":"integer","description":"The number of virtual appliances (VAs) deployed in the customer's organization","example":5},"comments":{"type":"array","items":{"type":"string"},"description":"The feedback about the customer's trial"},"sigQuestionnaire":{"type":"string","description":"The SIG questionnaire","example":"'IPSec Tunnel:\\n\\tLocations:1\\n\\tLocation:\\t\\t\\tPeak Throughput:\\n\\nProxy Chaining:\\n\\t\nProxy IPAddress:\\n\\tProxy Vendor: \\n\\tProxy Bandwidth: \\n\\tProxy Seats: \\n\\tProxy Type: \\n\\n\nPac Files: false\\n\\nAny Connect: \\n\\nFeature Needs:'","$$ref":"#/components/schemas/sigQuestionnaire"}},"example":{"isReportReady":true,"organizationId":2345892,"organizationTypeId":4,"organizationName":"Cisco Systems","createdAt":1594557263,"packageId":7,"packageName":"SIG essentials","users":25,"trialStartsAt":"2023-03-01","trialEndsAt":"2023-07-01","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 mail identifier, no login four days","noOriginDayThreeMailIdentifier":"three day mail identifier, no origin","noOriginDaySevenMailIdentifier":"seven day mail identifer, no origin"},"excludedLifecycleEmails":["name@acmetech.com"]},"hasDistributorVisibility":true,"isOnboardingWizardCompleted":true,"trialId":"MD5 hash","accountManagerEmails":["name@cisco.com","name-one@cisco.com"],"serviceGracePeriodEndDate":1594557263,"networks":5,"roamingClients":25,"VAs":10,"comments":["A comment about the customer's trial"],"sigQuestionnaire":"'IPSec Tunnel:\\n\\tLocations:1\\n\\tLocation:\\t\\t\\tPeak Throughput:\\n\\nProxy Chaining:\\n\\t\nProxy IPAddress:\\n\\tProxy Vendor: \\n\\tProxy Bandwidth: \\n\\tProxy Seats: \\n\\tProxy Type: \\n\\n\nPac Files: false\\n\\nAny Connect: \\n\\nFeature Needs:'"},"$$ref":"#/components/schemas/DownloadReport","title":"DownloadReport"}}