列出用户

GET

/accounts/{accountId}/users

检索您的帐户的用户列表。

** 范围: ** 'user:master'

** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'MEDIUM'

请求参数

Path 参数

accountId

string

帐户的唯一标识符。

必需

Query 参数

status

string

可选

用户的状态。

“活动”-用户存在于帐户上。

“不活动”-用户已被停用。

“待定”-用户存在于帐户中，但尚未激活其帐户。有关详细信息，请参阅管理用户。

此值默认为 “活动”。

page_size

integer

可选

单个API调用中返回的记录数。

role_id

string

可选

角色的唯一ID。使用此参数按特定角色筛选响应。您可以使用 [** 列出角色 **](/api-reference/zoom-api/meths # operation/roles) api获取角色的唯一ID值。

page_number

string

可选

返回记录中当前页面的页码。

include_fields

string

可选

使用此参数可在API调用的响应中显示以下属性之一:

'custom_attributes'-返回用户的自定义属性。

'host_key'-返回用户的主机密钥。

next_page_token

string

可选

使用next page标记对大型结果集进行分页。只要可用结果集超过当前页面大小时，就会返回下一页令牌。此令牌的有效期为15分钟。

license

string

可选

用户的许可证。按特定许可证筛选响应。

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200** HTTP状态代码: ** '200' 返回用户列表。

application/json

Body

page_number

integer

当前结果的页码。

可选

默认值:

示例值:

next_page_token

string

可选

下一页标记用于通过大型结果集进行分页。每当可用结果集超过当前页面大小时，将返回下一页令牌。此令牌的有效期为15分钟。

示例值:

8V8HigQkzm2O5r9RUn31D9ZyJHgrmFfbLa2

total_records

integer

可选

跨页可用的所有记录的总数。

示例值:

8482

page_count

integer

可选

为发出的请求返回的页数。

示例值:

100

users

array [object {22}]

关于用户的信息。

可选

im_group_ids

array[string]

可选

用户为成员的IM目录组的id。

last_login_time

string <date-time>

可选

用户的上次登录时间。此字段具有三天的缓冲期。

例如，如果用户首先登录 '2020-01-01'，然后注销并登录 '2020-01-02'，此值仍将反映 '2020-01-01' 的登录时间。但是，如果用户在 '2020-01-04' 上登录，则此字段的值将反映相应的登录时间，因为它超过了三天的缓冲期。

示例值:

2022-03-25T05:40:55Z

user_created_at

string <date-time>

可选

创建此用户的日期和时间。

示例值:

2019-06-01T07:58:03Z

timezone

string

用户的时区。

可选

示例值:

Asia/Shanghai

verified

enum<integer>

可选

显示是否已验证Zoom帐户的用户电子邮件地址。

'1'-已验证用户电子邮件。

“0”-用户的电子邮件 ** 未 ** 验证。

枚举值:

示例值:

created_at

string <date-time>

已废弃

创建此用户的最新登录类型的日期和时间。

示例值:

2018-10-31T04:32:37Z

last_name

string

用户的姓氏。

可选

<= 64 字符

示例值:

Chill

dept

string

用户的部门。

可选

示例值:

Developers

type

enum<integer>

必需

用户分配的计划类型。

'1'-基本。

'2'-许可。

'4'-无会议许可证。

'99' - None (这只能用 'ssoCreate' 设置)。

枚举值:

12499

示例值:

display_name

string

用户的显示名称。

可选

<= 128 字符

示例值:

Jill Chill

pmi

integer <int64>

可选

用户的 [个人会议ID (PMI)](https://developers.zoom.us/docs/api/rest/using-zoop-api/# 了解-个人会议id-pmi)

示例值:

6589310093

custom_attributes

array [object {3}]

可选

有关用户的自定义属性的信息。

如果为用户分配了自定义属性，并且您在API请求中为 “include_fields” 查询参数提供了 “custom_attributes” 值，则 ** 仅返回 ** 此字段。

employee_unique_id

string

可选

员工的唯一ID。此字段仅在以下情况下返回:

已启用SAML单点登录 (SSO)。

“login_type” 值为 “101” (SSO)。

示例值:

HqDyI037Qjili1kNsSIrIg

host_key

string

可选

用户的主机密钥。

如果为用户分配了主机键，并且您在API请求中为 “include_fields” 查询参数提供了 “host_key” 值，则 ** 仅返回 ** 此字段。

示例值:

299492849

role_id

string

可选

用户分配的 [角色] 的唯一ID (/api-reference/zoom-api/方法 # 操作/角色)。

示例值:

group_ids

array[string]

可选

用户是其成员的组的id。

last_client_version

string

可选

用户用于登录的上一个客户端版本。

示例值:

5.2.45120.0906(win)

string

可选

用户的ID。

API不会 ** 为处于 “待定” 状态的用户返回此值。

示例值:

KDcuGIm1QgePTO8WbOqwIQ

first_name

string

用户的名字。

可选

<= 64 字符

示例值:

Jill

plan_united_type

enum<string>

可选

如果用户在 Zoom United 计划中注册，则返回此字段。许可证选项:

'1' - Zoom United Pro-United与US/CA Unlimited。

'2' - Zoom United Pro-与UK/IR Unlimited联合。

'4' - Zoom United Pro-与AU/NZ Unlimited联合。

'8' - Zoom United Pro-与Global Select联合。

'16' - Zoom United Pro-与Zoom Phone Pro联合。

'32' - Zoom United Biz-与US/CA Unlimited联合。

'64' - Zoom United Biz-与UK/IR Unlimited联合。

'128' - Zoom United Biz-与AU/NZ Unlimited联合。

'256' - Zoom United Biz-与Global Select联合。

'512' - Zoom United Biz-与Zoom Phone Pro联合。

'1024' - Zoom United Ent-United与US/CA Unlimited。

'2048' - Zoom United Ent-United与UK/IR Unlimited。

'4096' - Zoom United ent-united与AU/NZ无限。

'8192' - Zoom United ent-united与全球选择。

'16384' - Zoom United Ent-与Zoom Phone Pro联合。

'32768' - Zoom United Pro-United与JP Unlimited。

'65536' - Zoom United Biz-与JP Unlimited联合。

'131072' - Zoom United-United与JP Unlimited。

枚举值:

12481632641282565121024204840968192163843276865536131072

示例值:

string <email>

必需

用户的电子邮件地址。

示例值:

jchill@example.com

status

enum<string>

可选

用户的状态。

“活动”-活动用户。

'inactive'-停用的用户。

“待定”-一个待定用户。

枚举值:

activeinactivepending

示例值:

active

page_size

integer

可选

单个API调用中返回的记录数。

<= 300

默认值:

示例值:

示例

{
    "page_number": 1,
    "next_page_token": "8V8HigQkzm2O5r9RUn31D9ZyJHgrmFfbLa2",
    "total_records": 8482,
    "page_count": 100,
    "users": [
        {
            "im_group_ids": [
                "t-_-d56CSWG-7BF15LLrOw"
            ],
            "last_login_time": "2022-03-25T05:40:55Z",
            "user_created_at": "2019-06-01T07:58:03Z",
            "timezone": "Asia/Shanghai",
            "verified": 1,
            "created_at": "2018-10-31T04:32:37Z",
            "last_name": "Chill",
            "dept": "Developers",
            "type": 1,
            "display_name": "Jill Chill",
            "pmi": 6589310093,
            "custom_attributes": [
                {
                    "name": "A1",
                    "value": "2323",
                    "key": "cbf_cywdkexrtqc73f97gd4w6g"
                }
            ],
            "employee_unique_id": "HqDyI037Qjili1kNsSIrIg",
            "host_key": "299492849",
            "role_id": "0",
            "group_ids": [
                "t-_-d56CSWG-7BF15LLrOw"
            ],
            "last_client_version": "5.2.45120.0906(win)",
            "id": "KDcuGIm1QgePTO8WbOqwIQ",
            "first_name": "Jill",
            "plan_united_type": "1",
            "email": "jchill@example.com",
            "status": "active"
        }
    ],
    "page_size": 30
}

修改于 2023-10-31 06:13:33

创建用户

上传虚拟后台文件