getLicenseInfo
This method retrieves the license information for a company.
Parameters
Parameter | Type | Optional | Description |
---|---|---|---|
| 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. |
| 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 subscriptionisAddon
- whether the product is an add-onexpiryDate
- the license expiry dateusedSlots
- the number of used seatstotalSlots
- 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 otherwisemanageEncryption
- True if the company is allowed to manage the Full Disk Encryption feature, false otherwisemanageRemoteEnginesScanning
- True if the company is allowed to manage the Security for Virtualized Environments feature, false otherwisemanageHyperDetect
- True if the company is allowed to manage the HyperDetect feature, false otherwisemanageSandboxAnalyzer
- True if the company is allowed to manage the Sandbox Analyzer feature, false otherwisemanagePatchManagement
- True if the company is allowed to manage the Patch Management feature, false otherwisemanageEventCorrelator
- 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.manageContainerProtection
- True if the company is allowed to manage the Container Protection 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,2
for Response (deprecated). 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 MDR for own use.mdrServiceResell
, a boolean specifying whether the company is allowed to resell MDR services (Foundations and Response) 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 Security3
, for Bitdefender EDR
The parameter is returned only when subscriptionType has one of these values:
3
, for monthly subscription5
, for monthly subscription trial
additionalProductTypes
- An array of the product types that can be assigned to child companies:0
, for Endpoint Security3
, for Bitdefender EDR
The parameter is returned only when
subscriptionType
has one of these values:3
, for monthly subscription5
, for monthly subscription trial
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:
{ "id": "5087eab8-b74f-4a3e-85b3-4271e85890d5", "jsonrpc":"2.0", "result": { "subscriptionType": 3, "expiryDate": "2030-02-18T14:30:03", "usedSlots": 2, "totalSlots": null, "manageExchange": false, "manageExchange": false, "manageRemoteEnginesScanning": false, "manageHyperDetect": true, "manageSandboxAnalyzer": true, "managePatchManagement": false, "manageEventCorrelator": true, "manageEmailSecurity": false, "manageContainerProtection": false, "licensedServices": { "mdrServiceFlavor": 2, "mdrServiceStatus": 1, "mdrStatusStartDate": "2021-09-24T19:25:50", "mdrServiceResell": false }, "assignedProductType": 0, "additionalProductTypes": [] } }
Response:
{ "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" } ] } }