跳至主内容

addProductKey

此方法将许可证或附加密钥添加到现有的许可证和附加密钥列表中。

注意

对于按年授权的企业，可添加独立许可证和附加许可证。对于按月订阅授权的企业，仅可添加兼容附加组件的许可证。

参数

参数

类型

可选

描述

licenseKey

字符串

否

待设置的许可证密钥。可以是附加许可证或基础许可证。

replaceIncompatibleKeys

布尔型

是

若为true，所有与当前许可证密钥不兼容的现有基础许可证或附加许可证将被移除，新许可证将添加到现有基础许可证或附加密钥中。默认值为true。

mdrContactInformation

对象

是

包含公司指定紧急联系人详细信息的对象，供MDR团队在安全事件或事故时使用。

注意

该信息必须有效且对以下公司类型为必填项：

  • 任何需要启用MDR服务的年度许可证持有公司。

该对象包含以下字段：

  • phoneNumber ，包含通过电话联系公司所需联系人详细信息的对象。包含以下信息：

    • countryPrefix ，表示公司所在国家/地区前缀的整数。

      注意

      对于没有唯一前缀的国家/地区，需同时包含 countryCode 参数。

      以下前缀为多国共用： +1 , +599 , +39 , +7 , +39 .

    • countryCode ，表示公司所在国家的ISO 3166-1 alpha-2代码的字符串。

      注意

      该参数仅应在以下情况下替代 countryPrefix 使用：当公司所在地区与其他国家共用电话前缀时，用于标识国家。

    • subscriberNumber ，表示公司电话号码本地部分的字符串，不含国家前缀或国内拨号代码。

  • fullName ，包含公司指定紧急联系人全名的字符串。

  • email ，包含公司指定紧急联系人电子邮箱地址的字符串。

  • emailVerificationCode ，用于验证指定邮箱所有权的字符串或数字代码。

    注意

    可通过调用 generateEmailVerificationCode 方法获取此代码。

  • useDataFromAccount ——表示 GravityZone 用户账户ID的字符串，将从此账户导入所有相关联系信息（包括全名、邮箱和电话号码）。

    注意

    当指定此参数时，它将替换 phoneNumber , fullName 和 email 。这些参数与 useDataFromAccount .

    如果指定用户账户尚未通过验证，则请求中还必须包含 emailVerificationCode 。

  • useDataFromCompany - 一个表示 GravityZone 公司账户ID的环，用于导入所有相关联系信息（包括全名、电子邮件和电话号码）。

    注意

    当指定此参数时，它将替换 phoneNumber , fullName 和电子邮件。这些参数以及 emailVerificationCode 均与 useDataFromCompany .

返回值

此方法不返回任何值。

示例

请求 :

添加带有手动指定MDR联系信息的产品密钥。 

{
  "params": {
    "licenseKey": "TNB3AAA",

    "replaceIncompatibleKeys": true,
    "mdrContactInformation": {
      "phoneNumber": {
        "countryPrefix": "+4",
        "subscriberNumber": "112345"
      },
      "fullName": "联系人",
      "email": "mdrcontact@nebula.local",
      "emailVerificationCode": "43728676"
    }
  },
  "jsonrpc": "2.0",
  "method": "addProductKey",
  "id": "48daf1bc-4078-411c-bf44-4f293e68f501"
}

使用从用户账户导入的MDR联系信息添加产品密钥。 

{
  "params": {
    "licenseKey": "TNB3AAA",

    "replaceIncompatibleKeys": true,
    "mdrContactInformation": {
      "useDataFromAccount": "user-1234567890",
      "emailVerificationCode": "43728676"
    }
  },
  "jsonrpc": "2.0",
  "method": "addProductKey",
  "id": "48daf1bc-4078-411c-bf44-4f293e68f501"
}

使用从公司账户导入的MDR联系信息添加产品密钥。 

{
  "params": {
    "licenseKey": "TNB3AAA",

    "replaceIncompatibleKeys": true,
    "mdrContactInformation": {
      "useDataFromCompany": "company-0987654321"
    }
  },
  "jsonrpc": "2.0",
  "method": "addProductKey",
  "id": "48daf1bc-4078-411c-bf44-4f293e68f501"
}

响应 : 

{
        "id":"48daf1bc-4078-411c-bf44-4f293e68f501",
        "jsonrpc":"2.0",
        "result": null
}
本节内容 :