跳至主内容

createAccount

您可通过此方法创建用户账户并设置密码。

参数

参数

说明

包含于请求中

类型

取值

email

新账户的电子邮箱地址。

必填

字符串

无额外要求。

userName

账户的用户名。

必填项

字符串

仅允许使用以下元素:

  • 任意语言的字母

  • 数字

  • 空格

  • 以下特殊字符: @ , ! , # , $ , % , & , ' , * , + , - , . , / , \ , [ , ]| .

个人资料

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

必填

对象

参见 个人资料 .

电话号码

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

可选

对象

参见 电话号码 .

密码

新账户的密码。

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

可选

字符串

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

角色

新账户的角色。

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

可选

数字

可选值:

  • 1 - 公司管理员

  • 2 - 网络管理员

  • 3 - 报告员

  • 5 - 自定义

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

默认值: 1

rights

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

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

可选

对象

参考 rights .

targetIds

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

可选

数组

无额外要求。

这些是所有公共API方法共有的参数。

参数

描述

包含在请求中

类型

取值

id

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

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

必填

字符串

无额外要求

method

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

必填

字符串

必须是有效的方法名称。

jsonrpc

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

必填

整数

可选值:

  • 2.0

params

包含请求配置的对象。

必填

对象

无额外要求。

params 对象中

页面

结果页码。

可选

整数

默认值: 1

每页条数

每页显示的结果数量。

可选

整数

每页上限为100条。

默认值: 30

对象

个人资料

名称

描述

包含在请求中

类型

全名

用户的全名。

必填

字符串

时区

用户所在时区。

可选

字符串

语言

GravityZone 控制台中显示的语言。

可选

字符串

电话号码

名称

描述

包含在请求中

类型

国家代码

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

必填

字符串

用户号码

不带前缀的电话号码。

必填

字符串

权限

名称

描述

包含在请求中

类型

管理网络

重要

manageNetworks 属性已弃用。建议使用 manageInventory , managePoliciesReadmanagePoliciesWrite 属性替代。

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

  • 网络资产清单

  • 策略

  • 任务

  • 安装包

  • 隔离区

若设为 true ,则 manageReports 权限将自动获得相同值。

若存在 manageNetworks 属性,其值将自动赋给 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","userName":"Client""profile": {
               "fullName": "Bitdefender用户",
               "language": "en_US",
               "timezone": "Europe/Bucharest"
           },
           "phoneNumber": {
               "countryCode": "+40",
               "subscriberNumber": "0000000000"
           },
           "password": "P@s4w0rd",
           "role": 5,
           "rights": {
                             
               "manageInventory": true,
               "managePoliciesRead": true,
               "managePoliciesWrite": true,
               "manageReports": true,
               "manageUsers": false
           },
                      
           "targetIds": [
               "585d2dc9aaed70820e8b45b4",
               "585d2dd5aaed70b8048b45ca"
           ]
       }
}

响应

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