跳至主内容

更新账户

此方法通过账户ID更新指定用户账户。

参数

参数

描述

包含在请求中

类型

取值

accountId

目标用户账户的ID。

必填

字符串

无额外要求。

email

账户关联的电子邮件地址。

可选

字符串

必须符合有效电子邮件格式。

authenticationMethod

用户登录所需的认证方式。

可选

整数

可选值:

  • 0 - GravityZone 凭证

  • 1 - 身份提供商

  • 2 - GravityZone身份提供商

password

账户密码。

可选

字符串

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

profile

包含个人资料信息的对象: fullName , timezonelanguage .

可选

对象

更多信息请参考 profile .

phoneNumber

包含电话号码信息的对象

可选

对象

更多信息请参考 phoneNumber .

role

用户的新角色。

可选

整数

以下是可用角色:

  • 1 - 公司管理员。

  • 2 - 网络管理员。

  • 3 - 报告员。

  • 4 - 合作伙伴

  • 5 - 自定义。此角色必须指定具体权限。

权限

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

该对象仅当 role 参数值为 5 - 自定义时需设置。

为其他角色设置时,相关值将被忽略并替换为该角色特定权限。

可选

对象

更多信息请参阅 权限 .

targetIds

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

可选

数组

无额外要求。

对象

profile

参数

描述

是否包含在请求中

类型

取值范围

fullName

用户的全名(包含姓氏和名字)。

必填

字符串

无额外要求

language

控制中心显示的语言。

必填

字符串

无额外要求

timezone

用户所在工作地的时区。

必填

字符串

无额外要求

phoneNumber

参数

描述

是否包含在请求中

类型

取值

countryCode

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

必填

整数

必须是有效的国家代码前缀。

subscriberNumber

不含前缀的电话号码。

必填

整数

必须是有效的电话号码格式。

权限

参数

描述

是否包含在请求中

类型

取值

manageCompanies

允许用户创建、删除、暂停客户公司,并管理其许可证及安全设置。

可选

布尔值

默认值: false .

manageNetworks

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

  • 网络清单

  • 策略

  • 任务

  • 安装包

  • 隔离区

提示

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 .

返回值

此方法返回布尔值,当用户账户成功更新时为True。

示例

请求

{
       "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
       "jsonrpc": "2.0",
       "method": "updateAccount",
       "params": {
           "accountId" : "585d3d3faaed70970e8b45ed",
           "email": "client@bitdefender.com",
           "authenticationMethod" : 2,
           "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
           },
           "targetIds": [
               "585d2dc9aaed70820e8b45b4",
               "585d2dd5aaed70b8048b45ca"
           ]
       }
  }

响应

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