Skip to main content

getLicenseInfo

This method retrieves the license information for a company.

Parameters

Parameter

Type

Optional

Description

companyId

String

Yes

The ID of the company for which the license information is retrieved. The default value is the ID of the company linked to the user who generated the API key.

returnAllProducts

Boolean

Yes

If true, information about all the products of the given company will be included in the response. The default value is false.

Return value

This method returns an Array containing the license details:

  • subscriptionType - the company's subscription type: 1 for trial subscription, 2 for licensed subscription, 3 for monthly subscription, 4 for monthly license trial, 5 for monthly subscription trial, 6 for FRAT subscription

  • isAddon - whether the product is an add-on

  • expiryDate - the license expiry date

  • usedSlots - the number of used seats

  • totalSlots - the number of total seats for licensed subscriptions, or the number of reserved seats for child companies that inherited a monthly license from their parent company.

  • licenseKey - the license key for trial or licensed subscriptions.

  • endSubscription - the subscription end date. This option is available for companies with monthly subscription.

  • autoRenewPeriod - the subscription auto renewal period in months. This option is available for companies with monthly subscription.

  • manageExchange - True if the company is allowed to manage the Security for Exchange feature, false otherwise

  • manageEncryption - True if the company is allowed to manage the Full Disk Encryption feature, false otherwise

  • manageRemoteEnginesScanning - True if the company is allowed to manage the Security for Virtualized Environments feature, false otherwise

  • manageHyperDetect - True if the company is allowed to manage the HyperDetect feature, false otherwise

  • manageSandboxAnalyzer - True if the company is allowed to manage the Sandbox Analyzer feature, false otherwise

  • managePatchManagement - True if the company is allowed to manage the Patch Management feature, false otherwise

  • manageEventCorrelator - True if the company is allowed to manage the Endpoint Detection and Response feature, false otherwise.

  • manageEmailSecurity - True if the company is allowed to manage the Email Security feature, false otherwise.

  • manageMobileSecurity - True if the company is allowed to manage Mobile Security feature, false otherwise.

  • manageContainerProtection - True if the company is allowed to manage the Container Protection feature, false otherwise.

  • manageComplianceManager - True if the company is allowed to manage the Compliance Manager feature, false otherwise.

  • licensedServices, an object containing service settings for the company.

    • mdrServiceFlavor, an integer representing which MDR Service Flavor is enabled for the company's own use. Possible values: 1 for Foundations. This parameter is missing if the company doesn't have MDR for own use.

    • mdrServiceStatus, an integer representing MDR status. Possible values: 1 for Active, 2 for Inactive, 3 for Onboarding, 4 for Switching, 5 for Disabling. This parameter is missing if the company doesn't have MDR for own use.

    • mdrStatusStartDate, the service start date. This parameter is missing if the company doesn't have a license or subscription that procides access to the MDR service.

    • mdrServiceResell, a boolean specifying whether the company is allowed to resell MDR services to the companies it creates.

  • minimumUsage - 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.

  • assignedProductType - The type of product assigned to the company:

    • 0, for Endpoint Security

    • 3, for Bitdefender EDR

    The parameter is returned only when subscriptionType has one of these values:

    • 3, for monthly subscription

    • 5, for monthly subscription trial

  • additionalProductTypes - An array of the product types that can be assigned to child companies:

    • 0, for Endpoint Security

    • 3, for Bitdefender EDR

    The parameter is returned only when subscriptionType has one of these values:

    • 3, for monthly subscription

    • 5, for monthly subscription trial

  • assignedProtectionModel - A string representing the type of the protection model that the company uses.

    • aLaCarte

    • mspSecure

    • mspSecurePlus

    • mspSecureExtra

    This parameter is only returned when all the following conditions are met:

    • type = 3 (monthly subscription)

    • assignedProductType = 0 (Endpoint Security)

  • additionalProtectionModels - an array of strings representing types of protection models. This parameter indicates what additional protection models a Partner company can assign to their clients, apart from the ones provided by the assignedProtectionModel object.

    • aLaCarte

    • mspSecure

    • mspSecurePlus

    • mspSecureExtra

    This parameter is returned when one of these conditions are met:

    • assignedProductType = 3 (Bitdefender EDR), additionalProductType = 0 (Endpoint Security), and type = 3 (monthly security).

    • assignedProductType = 0 (Endpoint Security), type = 3 (monthly subscription).

  • manageIntegrityMonitoring - True if the company is allowed to manage the Integrity Monitoring feature, False otherwise.

  • imDataRetention - an integer representing the number of days the events will be stored for. It is only returned if manageIntegrityMonitoring is set to true. Possible values: 0 (7 days retention), 1 (90 days retention), 2 (180 days retention), or 3 (1 year retention).

  • ownUse, an object containing activation settings for the company's services and add-ons.

    • manageXDRIdentityProviders, a boolean specifying whether the company is allowed to activate Azure AD and Active Directory integration in Sensors Management.

    • manageXDRProductivityApps, a boolean specifying whether the company is allowed to activate Office 365 integration in Sensors Management.

    • manageXDRNetwork, a boolean specifying whether the company is allowed to activate Network Sensor integration in Sensors Management.

    • manageXDRCloudWorkloads, a boolean specifying whether the company is allowed to activate AWS integration in Sensors Management.

      Note

      If any of the manageXDRIdentityProviders, manageXDRProductivityApps, manageXDRNetwork or manageXDRCloudWorkloads parameters are set as true, XDR is activated for the company.

    • manageRemoteEnginesScanning, optional, indicates if Security for Virtualized Environments is activated for your company. Possible values: true or false. Default value: false.

    • manageEventCorrelator, optional, indicates if Endpoint Detection and Response (EDR) is activated for your company. Possible values: true or false. Default value: false.

    • manageSandboxAnalyzer, optional, indicates if Sandbox Analyzer is activated for your company. Possible values: true or false. Default value: false.

    • manageHyperDetect, optional, indicates if HyperDetect is activated for your company. Possible values: true or false. Default value: false.

    • managePHASR, optional, indicates if PHASR is activated for your company. Possible values: true or false. Default value: false.

    • manageEASM, optional, indicates if EASM is activated for your company. Possible values: true or false. Default value: false.

    • manageComplianceManager, optional, indicates if the Compliance Manager add-on is activated for your company. Possible values: true or false. Default value: false.

    The parameter is returned only when subscriptionType has one of these values:

    • 3, for monthly subscription

    • 5, for monthly subscription trial

  • resell, an object containing the company's reselling settings for services and add-ons.

    • manageXDRResell - a boolean specifying whether the company is allowed to sell the eXtended Detection and Response service to customers.

    • manageRemoteEnginesScanningResell, optional, indicates if the company can sell Security for Virtualized Environments to its customers. Possible values: true or false. Default value: false.

    • manageEventCorrelatorResell, optional, indicates if the company can sell Endpoint Detection and Response (EDR) to its customers. Possible values: true or false. Default value: false.

    • manageSandboxAnalyzerResell, optional, indicates if the company can sell Sandbox Analyzer to its customers. Possible values: true or false. Default value: false.

    • manageHyperDetectResell, optional, indicates if the company can sell HyperDetect to its customers. Possible values: true or false. Default value: false.

    • managePHASRResell, optional, indicates if the company can sell PHASR to its customers. Possible values: true or false. Default value: false.

    • manageEASMResell, optional, indicates if the company can sell EASM to its customers. Possible values: true or false. Default value: false.

    • manageComplianceManagerResell, optional, indicates if the company can sell the Compliance Manager add-on to its customers. Possible valies: true or false. Default value: false.

    The parameter is returned only when subscriptionType has one of these values:

    • 3, for monthly subscription

    • 5, for monthly subscription trial

  • edrDataRetention, an integer indicating if the EDR Data Retention feature is enabled for the company, and how long data 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.

  • reservedSlots - the number of total seats reserved for child companies. This option is available for Partner companies with monthly license.

  • additionalLicenses - Only present, if the company has multiple products (addons or base licenses) assigned. Array containing information about the addons and the main licenses assigned to the given company:

    • expiryDate, the license expiry date. If the product is an addon, this information is not available.

    • usedSlots, the number of used seats. If the product is an addon, this information is available only if the addon type is "Email Security" .

    • licenseKey, the license key for trial or licensed subscriptions.

    • isAddon, whether the product is an addon or a base license

Example

Request:

  {
       "params": {
          "companyId": "5493dcd2b1a43df00b7b23c6",
          "returnAllProducts": true
       },
       "jsonrpc": "2.0",
       "method": "getLicenseInfo",
       "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb"
  }

Response for monthly subscription:

{
  "isAddon": false,
  "expiryDate": "2025-04-22T00:00:00",
  "usedSlots": 2,
  "reservedSlots": 0,
  "totalSlots": null,
  "manageExchange": false,
  "manageEncryption": false,
  "manageRemoteEnginesScanning": false,
  "manageHyperDetect": true,
  "manageSandboxAnalyzer": true,
  "managePatchManagement": false,
  "manageEventCorrelator": true,
  "manageEmailSecurity": false,
  "manageMobileSecurity": false,
  "manageContainerProtection": false,
  "manageIntegrityMonitoring": false,
  "assignedProtectionModel": "mspSecureExtra",
  "additionalProtectionModels": [
    "aLaCarte",
    "mspSecure",
    "mspSecurePlus",
    "mspSecureExtra"
  ],
  "assignedProductType": 0,
  "additionalProductTypes": [
    0
  ],
  "ownUse": {
    "manageXDRIdentityProviders": true,
    "manageXDRProductivityApps": true,
    "manageXDRNetwork": false,
    "manageXDRCloudWorkloads": false,
    "manageRemoteEnginesScanning": false,,
    "manageContainerProtection": false,    
    "manageHyperDetect": true,
    "manageSandboxAnalyzer": true,
    "manageEventCorrelator": true,
    "managePHASR": false,
    "manageEASM": false,
    "manageComplianceManager": true
  },
  "resell": {
    "manageXDRResell": true,
    "manageRemoteEnginesScanningResell": false,
    "manageContainerProtectionResell": false,    
    "manageHyperDetectResell": true,
    "manageSandboxAnalyzerResell": true,
    "manageEventCorrelatorResell": true
    "managePHASRResell": true,
    "manageEASMResell": false,
    "manageComplianceManagerResell": true
  },
  "edrDataRetention": 0,
  "licensedServices": {
    "mdrServiceFlavor": 1,
    "mdrServiceStatus": 3,
    "mdrStatusStartDate": "2023-07-17T10:52:03",
    "mdrServiceResell": true
  },
  "subscriptionType": 3
}

Response for yearly license:

  {
       "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb",
       "jsonrpc": "2.0",
       "result": {
           "subscriptionType": 2,
           "isAddon": false,
           "expiryDate": "2021-12-28T17:16:52",
           "usedSlots": 0,
           "totalSlots": 50,
           "licenseKey": "ABG5DBF",
           "additionalLicenses": [
               {
                   "isAddon": false,
                   "expiryDate": "2021-12-28T17:16:52",
                   "usedSlots": 0,
                   "totalSlots": 50,
                   "licenseKey": "W5HAJDV"
               },
               {
                   "isAddon": false,
                   "expiryDate": "2021-12-28T15:35:14",
                   "usedSlots": 0,
                   "totalSlots": 1,
                   "licenseKey": "HFBYCXS"
               }
           ]
       }
  }
In this section: