Create Customer Trial Extensions - Cloud Security API

{"type":"api","title":"Create Customer Trial Extensions","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/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":{"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":[{"name":"customerId","in":"path","description":"The ID of the customer.","required":true,"schema":{"type":"integer","format":"int32"},"$$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":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The information about the customer.","required":["organizationId"],"properties":{"organizationId":{"type":"integer","description":"The ID of the organization.","$$ref":"#/components/schemas/organizationId"},"organizationTypeId":{"type":"integer","description":"The type ID of the customer's organization.","example":1234},"originId":{"type":"integer","description":"The origin ID created for the customer.","example":12443},"organizationName":{"type":"string","description":"The name of the customer's organization.","example":"acmeTech","$$ref":"#/components/schemas/organizationName"},"createdAt":{"type":"integer","description":"The time when the logo was created. Specify the time in milliseconds.","example":12345678934},"modifiedAt":{"type":"integer","description":"The time when the logo was last modified. Specify the time in milliseconds.","example":12345678934},"subscriptionId":{"type":"integer","description":"The ID of the subscription.","example":1325},"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"},"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"},"packageInternalName":{"type":"string","description":"The internal name for the package.","example":"SIG Essentials"},"users":{"type":"integer","description":"The number of users in the subscription.","example":200},"startsAt":{"type":"string","format":"date","description":"The start date of the subscription.","example":"2021-09-22"},"endsAt":{"type":"string","format":"date","description":"The end date of the subscription.","example":"2021-09-22"},"strength":{"type":"object","description":"The number of features consumed by a customer trial.","required":["customerLoggedIn","lastLoginDate","identitiesCreated","hasTraffic","trialStrength"],"properties":{"customerLoggedIn":{"type":"boolean","description":"Specify whether the trial customer logged into their organization.","example":true},"lastLoginDate":{"type":"string","format":"iso-date-time","description":"The date when the customer last logged into their organization.","example":"2022-10-03 13:42:39"},"identitiesCreated":{"type":"integer","description":"The number of identities that were created.","example":25},"hasTraffic":{"type":"boolean","description":"Specify whether the organization has traffic.","example":false},"trialStrength":{"type":"string","description":"The number of features used by the trial.\nThe hyphen (`-`) character indicates no features.","enum":["Low","Medium","High","-"],"example":"-"}},"example":{"customerLoggedIn":true,"lastLoginDate":"2022-10-03 13:42:39","identitiesCreated":12,"hasTraffic":false,"trialStrength":"-"},"$$ref":"#/components/schemas/TrialStrength"},"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"},"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"},"dealId":{"type":"string","description":"The deal ID.","example":"14a","$$ref":"#/components/schemas/dealId"},"ppovLifecycle":{"type":"object","description":"The email details about lifecycle events from a customer trial.","properties":{"state":{"type":"string","description":"The current state of the customer trial.","example":"customer trial is active"},"date":{"type":"string","format":"date","description":"The date of the lifecycle event.","example":"2021-09-28"},"enabled":{"type":"boolean","description":"Specify whether lifecycle emails are enabled.","example":true},"lastSentDate":{"type":"string","format":"date","description":"The date when the last lifecycle email was sent.","example":"2021-10-05"},"mailIdentifiers":{"type":"object","description":"The information about the 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"]}},"example":{"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"]},"$$ref":"#/components/schemas/PpovLifecycle"},"hasDistributorVisibility":{"type":"boolean","description":"Specify whether the distributor has visibility into the trial.","example":true},"isOnboardingWizardCompleted":{"type":"boolean","description":"Specify whether the customer has logged into Umbrella.","example":true},"trialId":{"type":"string","description":"The MD5 value of the organization ID.","example":"ajlkjiuasoidfjsdfkj1"},"accountManagerEmails":{"type":"array","items":{"type":"string"},"description":"The emails of the account managers.","example":["name@hello.com"]},"accessRequestId":{"type":"integer","description":"The ID of the access request to enable access to the child organization.","example":12344},"accessRequestState":{"type":"string","description":"The state of the access request.","enum":["approved","denied","pending"],"example":"approved"},"trialPeriod":{"type":"string","description":"The period of the trial, including the start and end times.","example":"Aug 18, 2022 - Oct 15, 2023"},"trialExtensionCount":{"type":"integer","description":"The number of extensions that are applied to the trial.","example":15},"trialExtendedDays":{"type":"integer","description":"The number of days to extend the trial.","example":7}},"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},"$$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":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Message for Invalid request","properties":{"message":{"type":"string","description":"Message for Invalid request"}}},"example":{"message":"Invalid request"}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Unauthorized request","properties":{"message":{"type":"string","description":"Message for Unauthorized request"}}},"example":{"message":"Unauthorized request"}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Message for Forbidden","properties":{"message":{"type":"string","description":"Message for Forbidden"}}},"example":{"message":"Forbidden"}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Message for Not Found","properties":{"message":{"type":"string","description":"Message for Not Found"}}},"example":{"message":"Not Found"}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Message for Server error","properties":{"message":{"type":"string","description":"Message for Server error"}}},"example":{"message":"server error"}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"createCustomerTrialExtensions","method":"post","path":"/providers/customers/{customerId}/trialExtensions"}}