跳至主内容

获取账户列表

此方法可用于显示属于某公司的所有用户账户。

仅返回API密钥生成账户可见的账户。若无符合请求参数的用户账户，则返回空列表。

注意

当获取账户列表时，生成API密钥的账户 将被忽略 .

参数

参数

类型

可选

描述

companyId

字符串

是

需要显示账户的公司ID。

默认值：发起请求所用API密钥所属的公司。

page

数字

是

结果页码。

默认值： 1 .

perPage

数字

是

每页显示的项目数量。

可选值： 1 - 100 .

默认值： 30 .

返回值

此方法返回一个包含用户账户信息的对象。返回的对象包含：

属性

类型

描述

page

整数

当前显示的页码。

pagesCount

整数

可用总页数。

perPage

整数

每页显示的项目数量。

items

对象

用户账户列表。

count

字符串

用户账户ID。

email

字符串

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

profile

对象

包含用户账户信息的属性列表

fullName

字符串

与用户账户关联的姓名。

timezone

字符串

与用户账户关联的时区。

language

字符串

与用户账户关联的语言。

landingPage

字符串

用户登录后跳转的页面 GravityZone .

角色

整数

表示分配给用户账户的角色。

可选值：

  • 1 - 公司管理员

  • 2 - 网络管理员

  • 3 - 报告员

  • 5 - 自定义

权限

对象

表示用户被授予哪些权限的属性列表。

每个属性的可选值：

  • false - 用户未启用该权限。

  • true - 用户已启用该权限。

注意

您可以在 createAccount .

passwordLifetime

整数

表示分配给用户账户的密码过期策略。

可能取值：

  • 0 - 密码永不过期。

  • 90 - 密码每90天过期一次。

    提示

    密码过期后，所有者将无法再使用该密码登录 GravityZone 并会被提示创建新密码。

默认值： 0 .

accountLockdown

布尔值

若为 true ，表示用户账户在5次失败尝试后将被锁定。

twoFactorAuthenticationStatus

布尔值

若为true，表示该用户账户已启用双因素认证(2FA)。

companyName

字符串

用户账户所属公司名称。

companyId

字符串

用户账户所属公司的ID。

authenticationMethod

整型

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

可选值：

  • 0 - GravityZone 凭据

  • 1 - 身份提供者

  • 2 - GravityZone 身份提供者

  • 3 - Vifor 认证（已弃用）

  • -1 - 无效认证方法

total

整数

请求返回的条目数量。

示例

请求： 

{
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "jsonrpc": "2.0",    "method": "getAccountsList",
    "params": {
            "perPage": 20,
            "page": 1,
           "companyId": "58541613aaed7090058b4567"
        }
   }

响应： 

{
   "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
   "jsonrpc": "2.0",
   "result": {
       "total": 2,
       "page": 1,
       "perPage": 20,
       "pagesCount": 1,
       "items": [
           {
              "id": "585d3170aaed70b7048b4633",
              "email": "client@bitdefender.com",
              "profile": {
                   "fullName": "Bitdefender 用户",
                   "language": "en_US",
                   "timezone": "Europe/Bucharest",
                   "landingPage": "dashboardV2"
              },
              "role": 5,
             "rights": {
                   "companyManager": false,
                   "manageCompanies": false,
                   "manageNetworks": true,
                   "manageInventory ": true,
                   "managePoliciesRead": true,
                   "managePoliciesWrite": true,
                   "manageReports": true,
                   "manageUsers": true,
                   "manageRemoteShell":true
               },
              "companyName": "bitdefender",
              "companyId": "58541613aaed7090058b4567",
              "authenticationMethod": 0
           },
           {
              "id": "585d3170aaed70b7048b4634",
              "email": "client2@bitdefender.com",
              "profile": {
                   "fullName": "Bitdefender 用户",
                   "language": "en_US",
                   "timezone": "Europe/Bucharest"
               },
               "role": 1,
               "rights": {
                   "companyManager": true,
                   "manageCompanies": false,
                   "manageNetworks": true,
                   "manageInventory ": true,
                   "managePoliciesRead": true,
                   "managePoliciesWrite": true,
                   "manageReports": true,
                   "manageUsers": true,
                   "manageRemoteShell":true
               },
              "passwordLifetime": 0,
              "accountLockdown": false,
              "twoFactorAuthenticationStatus": true,
              "companyName": "bitdefender",
              "companyId": "58541613aaed7090058b4567",
              "authenticationMethod": 0
           }
        ]
     }
  }
本节内容 :