跳至主要内容

setMonthlySubscription

该方法用于为公司启用月度订阅服务。

参数

参数

类型

可选

描述

companyId

字符串

将从母公司继承许可证席位的公司ID。

reservedSlots

数量

从母公司总席位中为目标公司确保的席位数量。默认值为0,表示不预留席位。若未传值,则参数保持原值。

removeReservedSlots

布尔值

设为True允许对此公司及其客户动态分配许可席位,False则禁止。默认值为False。

endSubscription

字符串

产品订阅的UTC截止日期。仅当许可订阅类型值为3(月度订阅)时可设置此参数。若要取消endSubscription设置,请使用空字符串:''。

autoRenewPeriod

数值

自动续期后的许可有效期(月)。仅当许可订阅类型值为3(月度订阅)时可设置此参数。若endSubscription已设置,默认值为12。设为0表示不自动续期。

manageExchange

布尔值

设为True允许该公司使用Exchange安全服务,False则禁止。默认值为False。

manageEncryption

布尔值

设为True允许该公司使用全盘加密服务,False则禁止。默认值为False。

manageRemoteEnginesScanning

布尔值

设为True允许该公司使用虚拟化环境安全服务,False则禁止。默认值为False。

重要提示

仅当 assignedProtectionModel 已分配 aLaCarte 值。

注意

若存在 manageRemoteEnginesScanningmanageRemoteEnginesScanningResell 参数设置于 ownUseresell 对象参数中,则不可使用此参数。

manageHyperDetect

布尔型

设为True允许企业使用HyperDetect服务,反之为False。默认值为False。

注意

若存在 manageHtperDetectmanageHyperDetectResell 参数设置于 ownUseresell 对象参数中,则不可使用此参数。

manageSandboxAnalyzer

布尔型

设为True允许公司使用沙盒分析器服务,False则不允许。默认值为False。

managePatchManagement

布尔型

设为True允许公司使用补丁管理服务,False则不允许。默认值为False。

manageEventCorrelator

布尔型

设为True允许公司使用端点检测与响应(EDR)服务,False则不允许。默认值为False。启用EDR需同时启用沙盒分析器和HyperDetect。该参数值变更将自动将manageSandboxAnalyzer和manageHyperDetect参数设为相同值。若省略传值则不影响这两个参数的现有设置。

manageEmailSecurity

布尔型

设为True允许公司使用邮件安全服务,False则不允许。默认值为False。

manageMobileSecurity

布尔型

设为True允许公司使用移动安全服务,False则不允许。默认值为False。

manageContainerProtection

布尔型

设为True允许公司使用容器保护服务,False则不允许。默认值为False。

重要提示

仅当 assignedProtectionModel 参数被赋值为 aLaCarte 时方可设为true

注意

若存在 manageContainerProtectionmanageContainerProtectionResell 参数位于 ownUseresell 对象参数下时不可使用。

manageComplianceManager

布尔值

设为True允许企业使用合规管理服务,False则禁止。默认值为False。

注意

当存在 manageComplianceManagermanageComplianceManagerResell 设置于 ownUseresell 对象参数下时,此参数不可使用。

managePHASR

布尔值

设为True允许企业使用PHASR服务,False则禁止。默认值为False。

注意

当存在 managePHASRmanagePHASRResell自用转售 对象参数存在时的设置。

管理EASM

布尔值

设为True允许企业使用EASM服务,False则禁止。默认值为False。

注意

若存在 管理EASM管理EASM转售 参数在 自用转售 对象中的设置,则不可使用此参数。

授权服务

对象

包含企业服务设置的对象。

此参数仅在创建许可证类型为 3 的企业时有效。若省略,服务将不可用。

  • 自用MDR服务 ,整数,表示企业自用的MDR服务类型。可选值:0表示禁用。若企业类型为合作伙伴,启用此服务将同时启用MDR服务转售。启用此选项也将启用EDR。若省略,服务将不可用。

    此参数仅可设置为 truetype 参数设置为 1 时(公司类型设置为客户)。

  • mdrServiceResell ,布尔值,指定是否允许公司向其创建的公司转售MDR服务。若省略,则不可转售。此选项仅对合作伙伴公司有意义。

assignedProductType

数字

分配给目标公司的产品类型。可选值:

  • 0 ,表示终端安全

  • 3 ,表示Bitdefender EDR

默认值为0。

additionalProductTypes

数组

此参数仅适用于合作伙伴公司。它是一个整数数组,表示合作伙伴可分配给其客户的产品类型。可能的整数值:

  • 0 ,表示终端安全

  • 3 ,表示Bitdefender EDR

若设置此参数,数组必须至少包含 assignedProductType 的值,且必须同时设置 assignedProductType 。若未设置,默认值为 assignedProductType .

assignedProtectionModel

字符串

assignedProtectionModel ,表示公司将要使用的保护模型类型的字符串。

可选值:

  • aLaCarte

  • mspSecure

  • mspSecurePlus

  • mspSecureExtra

默认值:取决于合作公司提供的保护模型。

只有在满足以下所有条件时才能使用此参数:

  • type = 3 (月度订阅)

  • assignedProductType = 0 (终端安全)

注意

分配给此参数的值将自动为 additionalProtectionModels 数组分配一个或多个值。

assignedProtectionModel

默认值为 additionalProtectionModels

aLaCarte

aLaCarte

msp安全版

msp安全版

msp安全增强版

msp安全版 , msp安全增强版

msp安全旗舰版

msp安全版 , msp安全增强版 , msp安全旗舰版

附加保护模式

字符串

表示保护模式类型的字符串数组。该参数允许合作伙伴公司为其客户分配除 分配的保护模式 对象提供的保护模式之外的额外保护模式。

可选值:

  • 按需定制

  • msp安全版

  • msp安全增强版

  • msp安全旗舰版

默认值:取决于 分配的保护模式 字段的赋值。

仅当满足以下任一条件时方可使用此参数:

  • 分配的产品类型 = 3 (Bitdefender EDR), 附加产品类型 必须包含 0 (终端安全), 且 类型 = 3 (月度订阅)。

  • 分配产品类型 = 0 (终端安全), 类型 = 3 (月度安全), 且 分配保护模型 已包含在请求中。

为客户设置新保护模型

字符串

当满足以下所有条件时使用此参数:

  • 您的请求从 附加保护模型 对象中移除分配给合作伙伴公司的值。

  • 目标公司拥有已分配保护模型供自用的客户公司。

您为此参数设置的值将替换在请求时正在使用但变得不可用的保护模型。

最低使用量

对象

一个对象,包含许可证类型及公司通过法律协议承诺每月最低使用量的槽位数:

  • endpointMonthlyUsage ,客户同意从主许可证中使用的最低端点数量。

manageIntegrityMonitoring

整数

允许公司使用完整性监控服务, 否则。默认值为 .

imDataRetention

整数

事件存储的天数。仅当 manageIntegrityMonitoring 时返回。可选值: 0 ( 7 天保留期), 1 ( 90 天保留期), 2 ( 180 天保留期), 3 ( 365 天保留期)。默认值为 0 ( 7 天保留期)。

edrDataRetention

整数

表示EDR数据保留存储时长的整数。仅在 manageEventCorrelator 设置为 true 时返回。可选值:

  • 0 - 未启用数据保留。

  • 1 - 启用90天数据保留。

  • 2 - 启用180天数据保留。

  • 3 - 启用1年数据保留。

ownUse

对象

包含公司服务及附加功能激活设置的对象。该参数仅在创建许可证类型为3或5(月度继承订阅)的公司时有效。

  • manageXDRIdentityProviders ,提供对Azure AD和Active Directory的传感器管理集成访问权限。可选值: truefalse .

  • manageXDRProductivityApps ,提供对Office 365、Google Workspace和Microsoft Intune的传感器管理集成访问权限。可选值: truefalse .

  • manageXDRNetwork ,提供对网络传感器的传感器管理集成访问权限。可选值: truefalse .

  • manageXDRCloudWorkloads ,提供对AWS和Azure云的传感器管理集成访问权限。可选值: truefalse .

    重要提示

    要为上述任一参数分配 true 值,必须同时启用 manageEventCorrelator 参数或 manageEventCorrelator 设置下的 ownuse 参数需设置为 true .

    注意

    true 赋给任意一个 manageXDRIdentityProviders , manageXDRProductivityApps , manageXDRNetworkmanageXDRCloudWorkloads 设置都将激活XDR功能。若要停用XDR,需将所有相关参数设为 false .

  • manageRemoteEnginesScanning 为可选参数,用于为贵公司激活虚拟化环境安全服务。可选值: truefalse 。默认值: false .

    重要提示

    此设置仅在 assignedProtectionModel 被分配了 aLaCarte 值时才能设为true。

    注意

    若存在 manageRemoteEnginesScanning 参数在 ownUse 对象之外,则不可使用此设置。

  • manageContainerProtection (可选)。为您的公司激活容器保护服务。可选值: truefalse 。默认值: false .

    重要提示

    此设置仅在 assignedProtectionModel 被分配了 aLaCarte 值时才能设为true。

    注意

    若存在 manageContainerProtection 参数在 ownUse 对象存在。

  • manageEventCorrelator ,一个布尔值,指定公司是否可以使用端点检测与响应(EDR)。默认值为 false 。将此参数设置为 true 将自动将 manageSandboxAnalyzermanageHyperDetect 设置(位于 ownuse 参数下)设为 true .

    注意

    如果 manageEventCorrelator 参数位于 ownUse 对象之外,则不能使用此设置。

  • manageSandboxAnalyzer ,一个布尔值,指定公司是否可以使用沙盒分析器。默认值为 false .

    注意

    如果 manageSandboxAnalyzer 参数位于 ownUse 对象存在。

  • manageHyperDetect ,一个布尔值,指定公司是否可以使用HyperDetect。默认值为 false .

    注意

    如果 manageHyperDetect 参数在 ownUse 对象之外存在,则不能使用此设置。

  • managePHASR ,一个布尔值,指定公司是否可以使用PHASR。默认值为 false .

    注意

    此设置仅在 true 时可用,如果 assignedProtectionModel 具有 mspSecure , mspSecurePlusmspSecureExtra 值。

    注意

    如果 managePHASR 参数在 ownUse 对象之外存在。

  • manageEASM ,一个布尔值,指定公司是否可以使用EASM。默认值为 false .

    注意

    此设置仅在 true 时,若 assignedProtectionModel 具有 mspSecure , mspSecurePlusmspSecureExtra 值时才可设置为

    注意

    如果 manageEASM 参数在 ownUse 对象之外存在,则不能使用此设置。

  • manageComplianceManager ,一个布尔值,指定公司是否可以使用Compliance Manager附加组件。默认值为 false .

    注意

    manageComplianceManager 参数存在于 ownUse 对象之外,则无法使用此设置。

resell

对象

包含贵公司服务和附加组件转售设置的对象。此参数仅在创建许可证类型为3或5(按月继承订阅)的公司时有意义。

  • manageXDRResell - 允许向客户销售扩展检测与响应服务。可选值: truefalse .

    注意

    若设为 true ,则 manageXDRIdentityProviders , manageXDRProductivityApps , manageXDRNetworkmanageXDRCloudWorkloads 将自动设置为 true (针对您管理的公司)。

  • manageRemoteEnginesScanningResell ,可选,允许向客户销售虚拟化环境安全服务。可选值: truefalse 。默认值: false .

    重要提示

    仅当 assignedProtectionModel 参数值为 aLaCarte 时,此设置才能设为true。

    注意

    若存在 manageRemoteEnginesScanning 参数(位于 resell 对象外部),则无法使用此设置。

  • manageContainerProtectionResell ,可选,允许向客户销售容器保护服务。可选值: truefalse 。默认值: false .

    重要提示

    仅当 additionalProtectionModels 参数已分配 aLaCarte 值。

    注意

    若存在 manageContainerProtection 参数在 ownUse 对象外部,则不可使用此设置。

  • manageEventCorrelatorResell (可选)允许向客户销售端点检测与响应(EDR)服务。可选值: truefalse 。默认值: false 。将此设置设为 true 将自动将 manageSandboxAnalyzerResellmanageHyperDetectResell 设置置于 resell 参数下为 true .

    注意

    若存在 manageEventCorrelator 参数在 ownUse 对象外部存在时不可使用。

  • manageSandboxAnalyzerResell ,可选,允许向客户销售沙箱分析器。可选值: truefalse 。默认值: false .

    注意

    manageSandboxAnalyzer 参数在 ownUse 对象外部存在,则此设置不可用。

  • manageHyperDetectResell ,可选,允许向客户销售HyperDetect。默认值为 false .

    注意

    manageHyperDetect 参数在 ownUse 对象外部存在,则此设置不可用。

  • managePHASRResell ,允许向客户销售PHASR。默认值为 false .

    注意

    managePHASRResell 参数出现在 ownUse 对象之外,则不可使用此设置。

  • manageEASMResell ,允许向客户销售EASM,默认值为 false .

    注意

    manageEASMR 参数出现在 ownUse 对象之外,则不可使用此设置。

  • manageComplianceManagerResell ,可选,允许向客户销售合规管理器附加组件,默认值为 false .

    注意

    manageComplianceManager 参数出现在 ownUse 对象之外,则不可使用此设置。

返回值

此方法不返回任何值。

示例

请求 :

{
    "params": {
        "companyId": "64be4c5cb904ea72f3001049",
        "reservedSlots": 120,
        "removeReservedSlots": false,
        "endSubscription": "2029-04-14",
        "autoRenewPeriod": 12,
        "manageExchange": false,
        "manageEncryption": false,
        "managePatchManagement": false,
        "edrDataRetention": false,
        "ownUse": {
            "manageXDRIdentityProviders": false,
            "manageXDRProductivityApps": false,
            "manageXDRNetwork": false,
            "manageXDRCloudWorkloads": false,
            "manageRemoteEnginesScanning": false,
            "manageContainerProtection": false,
            "manageHyperDetect": true,
            "manageSandboxAnalyzer": true,
            "manageEventCorrelator": true,
            "managePHASR": true,
            "manageEASM": true,
            "manageComplianceManager": true
        },
        "resell": {
            "manageXDRResell": true,
            "manageRemoteEnginesScanningResell": true,
            "manageContainerProtectionResell": true,
            "manageHyperDetectResell": true,
            "manageSandboxAnalyzerResell": true,
            "manageEventCorrelatorResell": true,
            "managePHASRResell": true,
            "manageEASMResell": true,
            "manageComplianceManagerResell": true
        },
        "manageEmailSecurity": false,
        "manageIntegrityMonitoring": true,
        "imDataRetention": 2,
        "licensedServices": {
            "mdrServiceOwnUse": 1,
            "mdrServiceResell": true
        },
        "minimumUsage": {
            "endpointMonthlyUsage": 120
        },
        "assignedProductType": 0,
        "additionalProductTypes": [
            0
        ],
        "assignedProtectionModel": "mspSecure",
        "additionalProtectionModels": [
            "aLaCarte",
            "mspSecure",
            "mspSecurePlus"
        ],
        "setNewProtectionModelForClients": "aLaCarte"
    },
    "jsonrpc": "2.0",
    "method": "setMonthlySubscription",
    "id": "d4d50719-3215-455a-a329-086fe77f6d72"
}

响应 :

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