companyId
| String | No | The ID of the company that will inherit license seats from the parent company. |
reservedSlots
| Number | Yes | The number of seats ensured for the target company from the parent's company total amount of seats. The default value is 0, meaning that no seats will be reserved. If no value is passed, the parameter preserves its previous value. |
removeReservedSlots
| Boolean | Yes | True for allowing dynamic provisioning of license seats to this company and its clients, False otherwise. Default value is False. |
endSubscription
| String | Yes | The UTC end date for the product subscription. This parameter can be set when license subscription type has the value 3 (monthly subscription). To unset endSubscription use empty string: ''. |
autoRenewPeriod
| Number | Yes | The license validity in months, after auto renewal. This parameter can be set when license subscription type has the value 3 (monthly subscription). The default value is 12, provided endSubscription is set. For no auto-renewal use 0. |
manageExchange
| Boolean | Yes | True for allowing the company to use the Security for Exchange service, False otherwise. Default value is False. |
manageEncryption
| Boolean | Yes | True for allowing the company to use the Full Disk Encryption service, False otherwise. Default value is False. |
manageRemoteEnginesScanning
| Boolean | Yes | True for allowing the company to use the Security for Virtualized Environments service, False otherwise. Default value is False. ImportantThis setting can only be set to true if assignedProtectionModel has the aLaCarte value assigned. NoteThis parameter can not be used if any of the manageRemoteEnginesScanning and manageRemoteEnginesScanningResell settings under the ownUse and resell object parameters exist. |
manageHyperDetect
| Boolean | Yes | True for allowing the company to use the HyperDetect service, False otherwise. Default value is False. NoteThis parameter can not be used if any of the manageHtperDetect and manageHyperDetectResell settings under the ownUse and resell object parameters exist. |
manageSandboxAnalyzer
| Boolean | Yes | True for allowing the company to use the Sandbox Analyzer service, False otherwise. Default value is False. |
managePatchManagement
| Boolean | Yes | True for allowing the company to use the Patch Management service, False otherwise. Default value is False. |
manageEventCorrelator
| Boolean | Yes | True for allowing the company to use the Endpoint Detection and Response (EDR) service, False otherwise. Default value is False. EDR requires Sandbox Analyzer and HyperDetect to be enabled. Any change of this parameter's value will automatically set the parameters manageSandboxAnalyzer and manageHyperDetect with the same value. Omitting passing a value will not affect the values set for these two parameters. |
manageEmailSecurity
| Boolean | Yes | True for allowing the company to use the Email Security service, False otherwise. Default value is False. |
manageMobileSecurity
| Boolean | Yes | True for allowing the company to use the Mobile Security service, False otherwise. Default value is False. |
manageContainerProtection
| Boolean | Yes | True for allowing the company to use the Container Protection service, False otherwise. Default value is False. ImportantThis setting can only be set to true if assignedProtectionModel has the aLaCarte value assigned. NoteThis parameter can not be used if any of the manageContainerProtection and manageContainerProtectionResell settings under the ownUse and resell object parameters exist. |
manageComplianceManager
| Boolean | Yes | True for allowing the company to use the Compliance Manager service, False otherwise. Default value is False. NoteThis parameter can not be used if any of the manageComplianceManager and manageComplianceManagerResell settings under the ownUse and resell object parameters exist. |
managePHASR
| Boolean | Yes | True for allowing the company to use the PHASR service, False otherwise. Default value is False. NoteThis parameter can not be used if any of the managePHASR and managePHASRResell settings under the ownUse and resell object parameters exist. |
manageEASM
| Boolean | Yes | True for allowing the company to use the EASM service, False otherwise. Default value is False. NoteThis parameter can not be used if any of the manageEASM and manageEASMResell settings under the ownUse and resell object parameters exist. |
licensedServices
| Object | Yes | An object containing service settings for the company. This parameter makes sense only when creating a company with license of type 3 . If omitted, the service will be unavailable. mdrServiceOwnUse , an integer representing which MDR Service type is enabled for the company's own use. Possible values: 0 for Disabled. Enabling this also enables MDR service reselling if the company type is Partner. Enabling this option will also enable EDR. If omitted, the service will be unavailable.
This parameter can only be set to true if the type parameter is set to 1 (the company type is set to customer). mdrServiceResell , a boolean specifying whether the company is allowed to resell MDR services to the companies it creates. If omitted, reselling will be unavailable. This makes sense only for partner companies.
|
assignedProductType
| Number | Yes | The product type assigned to the target company. Possible values: 0 , for Endpoint Security
3 , for Bitdefender EDR
The default value is 0. |
additionalProductTypes
| Array | Yes | This parameter applies only to Partner companies. It is an array of integers representing the product types that the Partner can assign to its clients. Possible integer values: 0 , for Endpoint Security
3 , for Bitdefender EDR
If you set this parameter, the array must contain at least the value of assignedProductType and you must also set the assignedProductType . If not set, the default value is the value of assignedProductType . |
assignedProtectionModel
| String | Yes | assignedProtectionModel , a string representing the type of the protection model that the company will use.
Possible values: aLaCarte
mspSecure
mspSecurePlus
mspSecureExtra
Default value: depends on the protection models made available by the partner company. You can only use this parameter if all the following conditions are met: NoteThe value assigned to this parameter will automatically assign one or more values to the additionalProtectionModels array. |
additionalProtectionModels
| String | Yes | An array of strings representing types of protection models. This parameter allows a Partner company to assign additional protection models to their clients apart from the ones provided by the assignedProtectionModel object. Possible values: aLaCarte
mspSecure
mspSecurePlus
mspSecureExtra
Default value: depends on the value assigned to the assignedProtectionModel field. You can only use this parameter if one the following conditions are met: assignedProductType = 3 (Bitdefender EDR), additionalProductType must include 0 (Endpoint Security), and type = 3 (monthly subscription).
assignedProductType = 0 (Endpoint Security), type = 3 (monthly security), and assignedProtectionModel is included in the request.
|
setNewProtectionModelForClients
| String | Yes | Use this parameter when ALL these conditions apply: The value you set to this parameter will replace the protection model that is made unavailable for the companies that were using it at the time of the request. |
minimumUsage
| Object | Yes | An Object containing types of licenses and the minimum number of slots which the company commits through legal agreement to use on a monthly basis: |
manageIntegrityMonitoring
| Integer | Yes | True for allowing the company to use the Integrity Monitoring service, False otherwise. Default value is False .
|
imDataRetention
| Integer | No | The number of days the events will be stored for. It is only returned if manageIntegrityMonitoring is true . Possible values: 0 (7 days retention), 1 (90 days retention), 2 (180 days retention), 3 (365 days retention). The default value is 0 (7 days retention). |
edrDataRetention
| Integer | No | An integer indicating how long EDR data retention is stored. It is only returned if manageEventCorrelator is set to true . Possible values: 0 - Data retention is not enabled.
1 - Data retention is enabled for 90 days.
2 - Data retention is enabled for 180 days.
3 - Data retention is enabled for 1 year.
|
ownUse
| Object | Yes | An object containing activation settings for the company's services and add-ons. This parameter makes sense only when creating a company with license of type 3 or 5 (monthly inherited subscription). manageXDRIdentityProviders , gives access to Sensors Management integration for Azure AD and Active Directory. Possible values: true or false .
manageXDRProductivityApps , gives access to Sensors Management integration for Office 365, Google Workspace and Microsoft Intune. Possible values: true or false .
manageXDRNetwork , gives access to Sensors Management integration for Network Sensor. Possible values: true or false .
manageXDRCloudWorkloads , gives access to Sensors Management integration for AWS and Azure Cloud. Possible values: true or false .
ImportantTo assign the true value to any of the parameters above, the manageEventCorrelator parameter or the manageEventCorrelator setting under the ownuse parameter needs to be set to true . NoteAssigning true to any of the manageXDRIdentityProviders , manageXDRProductivityApps , manageXDRNetwork or manageXDRCloudWorkloads settings will activate XDR. To deactivate XDR, set all of them to false . manageRemoteEnginesScanning , optional, activates the Security for Virtualized Environments service for your company. Possible values: true or false . Default value: false .
ImportantThis setting can only be set to true if assignedProtectionModel has the aLaCarte value assigned. NoteThis setting can not be used if the manageRemoteEnginesScanning parameter outside of the ownUse object is present. manageContainerProtection , optional. activates the Container Protection service for your company. Possible values: true or false . Default value: false .
ImportantThis setting can only be set to true if assignedProtectionModel has the aLaCarte value assigned. NoteThis setting can not be used if the manageContainerProtection parameter outside of the ownUse object is present. manageEventCorrelator , a boolean specifying whether the company can use Endpoint Detection and Response (EDR) or not. The default value is false . Setting this parameter to true will automatically set the manageSandboxAnalyzer and manageHyperDetect settings under the ownuse parameter to true .
NoteThis setting can not be used if the manageEventCorrelator parameter outside of the ownUse object is present. manageSandboxAnalyzer , a boolean specifying whether the company can use Sandbox Analyzer or not. The default value is false .
NoteThis setting can not be used if the manageSandboxAnalyzer parameter outside of the ownUse object is present. manageHyperDetect , a boolean specifying whether the company can use HyperDetect or not. The default value is false .
NoteThis setting can not be used if the manageHyperDetect parameter outside of the ownUse object is present. managePHASR , a boolean specifying whether the company can use PHASR or not. The default is false .
NoteThis setting can only be set to true if assignedProtectionModel has the mspSecure , mspSecurePlus , or mspSecureExtra value. NoteThis setting can not be used if the managePHASR parameter outside of the ownUse object is present. manageEASM , a boolean specifying whether the company can use EASM or not. The default is false .
NoteThis setting can only be set to true if assignedProtectionModel has the mspSecure , mspSecurePlus , or mspSecureExtra value. NoteThis setting can not be used if the manageEASM parameter outside of the ownUse object is present. manageComplianceManager , a boolean specifying whether the company can use the Compliance Manager add-on or not. The default value is false .
NoteThis setting can not be used if the manageComplianceManager parameter outside of the ownUse object is present.
|
resell
| Object | Yes | An object containing your company's reselling settings for services and add-ons. This parameter makes sense only when creating a company with license of type 3 or 5 (monthly inherited subscription). manageXDRResell - allows selling the eXtended Detection and Response service to your customers. Possible values: true or false .
NoteIf true , the manageXDRIdentityProviders , manageXDRProductivityApps , manageXDRNetwork and manageXDRCloudWorkloads will automatically be set as true for your managed companies. manageRemoteEnginesScanningResell , optional, allows selling the Security for Virtualized Environments service to your customers. Possible values: true or false . Default value: false .
ImportantThis setting can only be set to true if assignedProtectionModel has the aLaCarte value assigned. NoteThis setting can not be used if the manageRemoteEnginesScanning parameter outside of the resell object is present. manageContainerProtectionResell , optional, allows selling the Container Protection service to your customers. Possible values: true or false . Default value: false .
ImportantThis setting can only be set to true if the additionalProtectionModels parameter has the aLaCarte value assigned. NoteThis setting can not be used if the manageContainerProtection parameter outside of the ownUse object is present. manageEventCorrelatorResell , optional, allows selling Endpoint Detection and Response (EDR) to your customers. Possible values: true or false . Default value: false . Setting this setting to true will automatically set the manageSandboxAnalyzerResell and manageHyperDetectResell settings under the resell parameter to true .
NoteThis setting can not be used if the manageEventCorrelator parameter outside of the ownUse object is present. manageSandboxAnalyzerResell , optional, allows selling Sandbox Analyzer to your customers. Possible values: true or false . Default value: false .
NoteThis setting can not be used if the manageSandboxAnalyzer parameter outside of the ownUse object is present. manageHyperDetectResell , optional, allows selling HyperDetect to your customers. The default value is false .
NoteThis setting can not be used if the manageHyperDetect parameter outside of the ownUse object is present. managePHASRResell , allows selling PHASR to your customers. The default is false .
NoteThis setting can not be used if the managePHASRResell parameter outside of the ownUse object is present. manageEASMResell , allows selling EASMto your customers. The default is false .
NoteThis setting can not be used if the manageEASMR parameter outside of the ownUse object is present. manageComplianceManagerResell , optional, allows selling the Compliance Manager add-on to your customers. The default value is false .
NoteThis setting can not be used if the manageComplianceManager parameter outside of the ownUse object is present.
|