跳至主内容

createAccount

您可以使用此方法创建用户账户并为其分配密码。

参数

参数

描述

包含在请求中

类型

取值

email

新账户的电子邮箱地址。

必填

字符串

无额外要求。

profile

包含个人资料信息的对象。

必填

对象

参考 profile .

phoneNumber

包含电话号码信息的对象。

可选

对象

参考 phoneNumber .

password

新账户的密码。

若省略此值,系统将生成密码并通过邮件发送给用户

可选

字符串

密码长度至少十二位,必须包含至少一个大写字母、一个小写字母、一个数字、一个特殊字符,且不能与之前使用过的密码相同。

companyId

要在其下创建用户的公司ID。

可选

字符串

若未指定,账户将关联至持有用于发送请求的API密钥的公司。

角色

新账户的角色。

有关用户角色及相关权限的更多信息,请参阅 用户角色

可选

数字

可选值:

  • 1 - 公司管理员

  • 2 - 网络管理员

  • 3 - 报告员

  • 4 - 合作伙伴

  • 5 - 自定义

若将此参数赋值为 5 ,则需同时在请求中包含 权限 参数。

默认值: 1

权限

包含用户账户权限的对象。

仅当 角色 参数包含在请求中且赋值为 5 时使用此参数。其他情况下, 权限 参数的值将被忽略。

可选

对象

参见 权限 .

目标ID

表示用户账户需管理的目标ID列表。

可选

数组

无额外要求。

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

参数

描述

包含在请求中

类型

取值

id

该参数为请求添加标识符,将其与对应响应关联。

目标响应中会返回相同值,便于调用追踪。

必填

字符串

无额外要求

method

发起请求所调用的方法名称。

必填

字符串

必须是有效的方法名。

jsonrpc

请求与响应使用的JSON-RPC协议版本。

必填

整数

可选值:

  • 2.0

params

包含请求配置的对象。

必填

对象

无额外要求。

params 对象中

page

结果页码。

可选

整数

默认值: 1

perPage

每页显示的结果数量。

可选

整数

每页上限为100条。

默认值: 30

对象

profile

名称

描述

包含在请求中

类型

fullName

用户全名。

必填

字符串

时区

用户所在时区。

可选

字符串

语言

GravityZone 控制台中显示的语言。

可选

字符串

电话号码

名称

描述

包含在请求中

类型

国家代码

电话号码所在国家的前缀。

必填

字符串

用户号码

不含前缀的电话号码。

必填

字符串

权限

名称

描述

包含在请求中

类型

管理公司

允许用户创建、删除、暂停、管理客户公司的许可证和安全性。

默认值: false .

可选

布尔值

管理网络

重要提示

管理网络 属性已弃用。建议改用 管理库存 , 读取策略写入策略 属性替代。

提供以下网络安全设置的管理权限:

  • 网络清单

  • 策略

  • 任务

  • 安装包

  • 隔离区

若设置为 true ,则 管理报告 权限将自动赋予相同值。

如果存在 管理网络 属性,其值将自动赋给 manageInventory , managePoliciesReadmanagePoliciesWrite 属性。若尝试在同一请求中为这三个键分配其他值将导致错误。

默认值: false .

可选

布尔值

manageUsers

允许用户创建、删除或编辑其所属公司的用户账户。

默认值: false .

可选

布尔值

manageReports

允许用户创建、查看和编辑其所属公司的报告。

默认值: false .

可选

布尔值

companyManager

授予用户编辑其公司资料设置及调整许可证的权限。

默认值: false .

可选

布尔值

manageRemoteShell

允许用户在受管目标终端上启动远程Shell会话并执行高级取证操作。

若设置为 true ,则 manageNetworks 属性将自动设为true。

默认值: false .

可选

布尔值

manageInventory

提供对网络清单、任务、安装包和隔离项目的管理权限。

若请求中包含 manageNetworks 则不可包含此属性。

默认值: false .

可选

布尔值

managePoliciesRead

允许用户查看公司策略。

若请求中包含 manageNetworks 则不可包含此属性。

默认值: false .

可选

布尔型

managePoliciesWrite

允许用户创建和编辑公司策略。

若该值设为 true ,则必须将 managePoliciesRead 参数的值也设为 true 。若未包含 managePoliciesRead 属性或为其赋予不同值,将导致错误。

若存在 manageNetworks 则不可包含在请求中。

默认值: false .

可选

布尔型

返回值

属性

类型

描述

result

字符串

所创建用户账户的ID。

示例

请求

{
       "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
       "jsonrpc": "2.0",
       "method": "createAccount",
       "params": {
           "email": "client@bitdefender.com",
                      
           "profile": {
               "fullName": "Bitdefender用户",
               "language": "en_US",
               "timezone": "Europe/Bucharest"
           },
           "phoneNumber": {
               "countryCode": "+40",
               "subscriberNumber": "0000000000"
           },
           "password": "P@s4w0rd",
           "role": 5,
           "rights": {"companyManager": true,"manageInventory": true,
               "managePoliciesRead": true,
               "managePoliciesWrite": true,
               "manageReports": true,
               "manageUsers": false
           },"companyId": "58541613aaed7090058b4567","targetIds": [
               "585d2dc9aaed70820e8b45b4",
               "585d2dd5aaed70b8048b45ca"
           ]
       }
}

响应

{
   "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
   "jsonrpc": "2.0",
   "result": "585d2dc9aaed70820abc45b4"
   }