getLicenseInfo

该方法用于获取指定公司的许可证信息。

参数

参数	类型	可选	描述
`companyId`	字符串	是	需获取许可证信息的公司ID。默认值为生成API密钥用户关联的公司ID。
`returnAllProducts`	布尔值	是	若为true，响应中将包含给定公司的所有产品信息。默认值为false。

通用参数

这些是公共API方法中通用的参数。

参数	描述	包含在请求中	类型	取值
`id`	该参数为请求添加标识符，用于关联对应的响应。目标响应中会返回相同的值，便于追踪调用。	必填	字符串	无额外要求示例 "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb"
`method`	请求所使用的方法名称。	必填	字符串	必须是有效的方法名。示例 "method": "methodName"
`jsonrpc`	请求与响应所使用的JSON-RPC版本。	必填	整数	可选值： `2.0` 示例 "jsonrpc": "2.0"
`params`	包含请求配置的对象。	必填	对象	无额外要求。示例 "params": {...}
在 `params` 对象中
`page`	结果页码。	可选	整数	默认值： `1`
`perPage`	每页显示的结果数量。	可选	整数	每页上限为100条。默认值： `30`

返回值

此方法返回包含许可证详情的数组：

subscriptionType - 公司订阅类型： 1 表示试用订阅， 2 表示许可订阅， 3 表示月度订阅， 4 表示月度许可试用， 5 表示月度订阅试用， 6 表示FRAT订阅
isAddon - 标识该产品是否为附加组件
expiryDate - 许可证到期日期
usedSlots - 已使用的席位数量
totalSlots - 许可订阅的总席位数量，或从母公司继承月度许可的子公司的预留席位数量。
licenseKey - 试用或许可订阅的许可证密钥。
endSubscription - 订阅结束日期。该选项仅适用于月度订阅的公司。
autoRenewPeriod - 订阅自动续订周期（以月为单位）。该选项仅适用于月度订阅的公司。
manageExchange - 若公司被允许管理Security for Exchange功能则为True，否则为False
manageEncryption - 若公司被允许管理全盘加密功能则为True，否则为False
manageRemoteEnginesScanning - 若公司被允许管理虚拟化环境安全功能，则为True，否则为False
manageHyperDetect - 若公司被允许管理HyperDetect功能，则为True，否则为False
manageSandboxAnalyzer - 若公司被允许管理沙箱分析器功能，则为True，否则为False
managePatchManagement - 若公司被允许管理补丁管理功能，则为True，否则为False
manageEventCorrelator - 若公司被允许管理端点检测与响应功能，则为True，否则为False。
manageEmailSecurity - 若公司被允许管理邮件安全功能，则为True，否则为False。
manageMobileSecurity - 若公司被允许管理移动安全功能，则为True，否则为False。
manageContainerProtection - 若公司被允许管理容器保护功能，则为True，否则为False。
manageComplianceManager - 若公司被允许管理合规管理器功能，则为True，否则为False。
licensedServices ，包含公司服务设置的对象。
- mdrServiceFlavor ，表示公司自用启用的MDR服务类型的整数。若公司无自用MDR或公司类型为合作伙伴，则此参数缺失。
- mdrServiceStatus ，表示MDR状态的整数。可能取值： 1 表示活跃， 2 表示未激活， 3 表示正在启用中， 4 表示切换状态， 5 表示禁用状态。若公司未启用自用MDR服务，则此参数不返回。
- mdrStatusStartDate ，字符串类型，表示当前MDR状态生效的起始日期。
- mdrEnrollementStatus ，整型数字，表示MDR注册状态。可选值包括： 1 表示活跃状态， 2 表示非活跃状态， 3 表示注册中状态， 5 表示禁用状态。若公司未启用自用MDR服务，或账户未开通MDR服务或超过30天未进行MDR注册，则此参数不返回。
- mdrStatusStartDate ，表示服务起始日期。若公司未持有可访问MDR服务的许可证或订阅，则此参数不返回。
- mdrServiceResell ，布尔值，标识公司是否被允许向其创建的下属公司转售MDR服务。若公司未持有月订阅或属于客户类型，则此参数不返回。
minimumUsage ——包含许可证类型及公司通过法律协议承诺每月最低使用量的对象：
- endpointMonthlyUsage ，表示客户同意从主许可证中使用的最低端点数量。
assignedProductType ——分配给公司的产品类型：
- 0 ，表示终端安全产品
- 3 ，表示Bitdefender EDR产品
该参数仅在subscriptionType取以下值时返回：
- 3 ，表示月度订阅
- 5 ，表示月度订阅试用
additionalProductTypes - 可分配给子公司的产品类型数组：
- 0 ，表示终端安全
- 3 ，表示Bitdefender EDR
该参数仅在 subscriptionType 取以下值时返回：
- 3 ，表示月度订阅
- 5 ，表示月度订阅试用
assignedProtectionModel - 表示公司所用保护模型类型的字符串。
- aLaCarte
- mspSecure
- mspSecurePlus
- mspSecureExtra
该参数仅在满足以下全部条件时返回：
- type = 3 （月度订阅）
- assignedProductType = 0 (终端安全)
additionalProtectionModels - 表示保护模型类型的字符串数组。该参数指示合作伙伴公司除了由 assignedProtectionModel 对象提供的保护模型外，还可以为其客户分配哪些额外的保护模型。
- aLaCarte
- mspSecure
- mspSecurePlus
- mspSecureExtra
满足以下任一条件时返回此参数：
- assignedProductType = 3 (Bitdefender EDR), additionalProductType = 0 (终端安全), 且 type = 3 (月度安全).
- assignedProductType = 0 (终端安全), type = 3 （月度订阅）。
manageIntegrityMonitoring - True 表示该公司是否被允许管理完整性监控功能， False 则表示不允许。
imDataRetention - 一个整数，表示事件存储的天数。仅当 manageIntegrityMonitoring 设置为 true 时返回。可选值： 0 （7天保留期）， 1 （90天保留期）， 2 （180天保留期），或 3 （1年保留期）。
ownUse ，一个包含公司服务和附加组件激活设置的对象。
- manageXDRIdentityProviders ，一个布尔值，指定该公司是否被允许在传感器管理中激活Azure AD和Active Directory集成。
- manageXDRProductivityApps ，一个布尔值，指定该公司是否被允许在传感器管理中激活Office 365集成。
- manageXDRNetwork ，一个布尔值，指定该公司是否被允许在传感器管理中激活网络传感器集成。
- manageXDRCloudWorkloads ，一个布尔值，指定公司是否被允许在传感器管理中激活AWS集成。
  
  注意
  
  如果 manageXDRIdentityProviders , manageXDRProductivityApps , manageXDRNetwork 或 manageXDRCloudWorkloads 任一参数设置为true， XDR 即会为公司激活。
- manageRemoteEnginesScanning ，可选，表示是否为您的公司激活了虚拟化环境安全功能。可能的值： true 或 false 。默认值： false .
- manageEventCorrelator ，可选，表示是否为您的公司激活了端点检测与响应（EDR）。可能的值： true 或 false 。默认值： false .
- manageSandboxAnalyzer ，可选参数，表示是否为您的公司启用了沙箱分析器。可选值： true 或 false 。默认值： false .
- manageHyperDetect ，可选参数，表示是否为您的公司启用了HyperDetect。可选值： true 或 false 。默认值： false .
- managePHASR ，可选参数，表示是否为您的公司启用了PHASR。可选值： true 或 false 。默认值： false .
- manageEASM ，可选参数，表示是否为您的公司启用了EASM。可选值： true 或 false 。默认值： false .
- manageComplianceManager ，可选参数，表示是否为您的公司激活了合规管理器附加组件。可能取值： true 或 false 。默认值： false .
该参数仅在 subscriptionType 取以下值时返回：
- 3 （月度订阅）
- 5 （月度试用订阅）
resell ，包含公司服务和附加组件转售设置的对象。
- manageXDRResell - 布尔值，指定公司是否被允许向客户销售扩展检测与响应服务。
- manageRemoteEnginesScanningResell ，可选参数，表示公司是否可以向其客户销售虚拟化环境安全解决方案。可能取值： true 或 false 。默认值： false .
- manageEventCorrelatorResell ，可选参数，表示该公司是否可以向其客户销售端点检测与响应（EDR）。可能取值： true 或 false 。默认值： false .
- manageSandboxAnalyzerResell ，可选参数，表示该公司是否可以向其客户销售沙箱分析器。可能取值： true 或 false 。默认值： false .
- manageHyperDetectResell ，可选参数，表示该公司是否可以向其客户销售HyperDetect。可能取值： true 或 false 。默认值： false .
- managePHASRResell ，可选参数，表示该公司是否可以向其客户销售PHASR。可能取值： true 或 false 。默认值： false .
- manageEASMResell ，可选参数，表示该公司是否可向客户销售EASM。可选值： true 或 false 。默认值： false .
- manageComplianceManagerResell ，可选参数，表示该公司是否可向客户销售合规管理器附加组件。可选值： true 或 false 。默认值： false .
该参数仅在 subscriptionType 取以下值时返回：
- 3 （月度订阅）
- 5 （月度试用订阅）
edrDataRetention ，整型值，表示是否为公司启用EDR数据保留功能及数据存储时长。仅当 manageEventCorrelator 设置为 true 时返回。可选值：
- 0 - 未启用数据保留功能。
- 1 - 数据保留功能启用，保留期为90天。
- 2 - 数据保留功能启用，保留期为180天。
- 3 - 数据保留功能启用，保留期为1年。
reservedSlots - 为子公司预留的总席位数量。此选项适用于按月订阅许可的合作伙伴公司。
additionalLicenses - 仅当公司分配了多个产品（附加组件或基础许可证）时出现。包含有关附加组件和分配给该公司的主许可证信息的数组：
- expiryDate ，许可证到期日期。若产品为附加组件，则不提供此信息。
- usedSlots ，已使用的席位数量。若产品为附加组件，则仅当附加组件类型为“邮件安全”时提供此信息。
- licenseKey ，试用版或授权订阅的许可证密钥。
- isAddon ，标识产品是否为附加组件或基础许可证
additionalLicenses ，包含按月订阅公司所附年度附加组件信息的对象。
- isAddon ，布尔值，标识产品是否为附加组件。
- licenseKey - 字符串，附加组件的许可证密钥。
- expiryDate ，字符串，表示产品到期时间。
- dailyIngestionVolume - 整数，表示该许可证允许安全数据湖每日摄取的数据量。
- activeDataPeriod - 整数，表示数据在安全数据湖控制台中可用的天数。
- archiveDataPeriod - 整数，表示数据在安全数据湖存档中可用的天数。
- dataLakeStorage - 对象，表示数据湖存储的使用情况。

示例

请求 :

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

月度订阅的响应 :

{
  "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": {
    "mdrStatusStartDate": "2023-07-17T10:52:03",
    "mdrEnrollementStatus": 3,
    "mdrServiceResell": true
  },
  "subscriptionType": 3,
 "additionalLicenses": [
            {
                "isAddon": true,
                "licenseKey": "CUEA49642HQX",
                "expiryDate": "2028-07-30T15:26:45",
                "dailyIngestionVolume": {
                    "total": 20,
                    "used": 0
                },
                "activeDataPeriod": 100,
                "archiveDataPeriod": 100,
                "dataLakeStorage": {
                    "total": 2,
                    "used": null
                }
            }
        ]
}

年度许可证的响应 :

{
  "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",
    "licensedServices": {
      "mdrServiceFlavor": 1,
      "mdrServiceStatus": 3,
      "mdrStatusStartDate": "2023-07-17T10:52:03",
      "mdrEnrollementStatus": 3
    },
    "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"
      }
    ]
  }
}

本节内容 :

getLicenseInfo

参数

通用参数

返回值

注意

示例

搜索结果