Skip to main content

PARTNERS

setMonthlySubscription

This method enables monthly subscription for a company.

Parameters

Parameter

Type

Optional

Description

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.

Note

This 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.

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.

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 or 5 (monthly inherited subscription). 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, 1 for Foundations, 2 for Response (deprecated). 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.

  • mdrServiceResell, a boolean specifying whether the company is allowed to resell MDR services (Foundations and Response) 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 company being created. 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.

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:

  • endpointMonthlyUsage, the minimum number of endpoints that the client agreed to use from the main license.

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).

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.

    Important

    To assign the true value to any of the parameters above, manageEventCorrelator needs to be set to true.

    Note

    Assigning 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.

    Note

    This setting can not be used if the manageRemoteEnginesScanning 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.

    Note

    If 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.

    Note

    This setting can not be used if the manageRemoteEnginesScanning parameter outside of the resell object is present.

Return value

This method does not return any value.

Example

Request:

  {
       "params": {
          "companyId" : "5493dcd2b1a43df00b7b23c6",
          "reservedSlots" : 12,
          "removeReservedSlots": false,
          "endSubscription": "2020-04-14",
          "autoRenewPeriod": 12,
          "manageExchange": false,
          "manageEncryption": false,
          "manageRemoteEnginesScanning": false,
          "manageHyperDetect": true,
          "manageSandboxAnalyzer": true,
          "managePatchManagement": false,
          "manageEventCorrelator": true,
          "ownUse": { 
               "manageXDRIdentityProviders": true,      
               "manageXDRProductivityApps": true,  
               "manageXDRNetwork": false,  
               "manageXDRCloudWorkloads": false, 
               "manageRemoteEnginesScanning": false,

          },
          "resell": { 
               "manageXDRResell": false,  
               "manageRemoteEnginesScanningResell": false,

          },
          "manageEmailSecurity" : false,
          "manageIntegrityMonitoring" : true,
          "imDataRetention" : 2,
          "licensedServices": {
               "mdrServiceOwnUse": 2,
               "mdrServiceResell: true 
          }
          "minimumUsage":{
               "endpointMonthlyUsage": 120
          },
          "assignedProductType": 0,
          "additionalProductTypes": [0]
       },
       "jsonrpc": "2.0",
       "method": "setMonthlySubscription",
       "id": "d4d50719-3215-455a-a329-086fe77f6d72"
  }

Response:

  {
      "id":"2b5f52d8-5f6f-466c-b952-61b5c87c3182",
      "jsonrpc":"2.0",
      "result": null
  }
In this section: