创建用户

POST

/accounts/{accountId}/users

Users

向您的Zoom帐户添加新用户。

** 注意: ** 当您对 “操作” 字段使用 “创建” 值时，将应用以下速率限制:

每天50个请求 ** 免费 ** 帐户。

每天1，500个 ** Pro ** 帐户请求。

每天10，000个 ** 业务 ** 帐户请求。

** 先决条件: **

专业或更高的计划。

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

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

请求参数

Path 参数

accountId

string

帐户的唯一标识符。

必需

Body 参数application/json

user_info

object

可选

password

string <password>

可选

用户密码。仅用于 “自动创建” 功能。密码必须最少8个字符，最多32个字符。默认情况下 (基本要求)，密码必须至少有一个字母 (a，b，c ..)，至少有一个数字 (1，2，3...) 并包括大写和小写字母。它不应该只重复包含一个相同的字符 ('11111111' 或 'aaaaaa')，并且不能包含连续的字符 ('12345678 '或 'abcdefgh')。

** 注意: ** 如果帐户所有者或管理员已启用 [增强密码要求](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings # h_fa9186e4-6818-4f7a-915c-2e25c19f0acd)，此字段中提供的值必须满足这些要求。可以通过调用 [** 获取帐户设置 **](/docs/api-reference/zoom-api/ma # operation/accountSettings) 来检索这些要求API，并引用 “security” 对象中存在的 “password_requirement” 字段。

>= 8 字符<= 32 字符

示例值:

if42!LfH@

feature

object

可选

有关用户功能的信息。

last_name

string

可选

用户的姓氏。不能包含超过5个中文字符。

<= 64 字符

示例值:

Chill

display_name

string

可选

用户的显示名称。不能包含超过10个中文字符。

<= 128 字符

示例值:

Jill Chill

type

enum<integer>

必需

用户类型。
'1'-基本。
“2”-许可。
'99' - None (这只能用 'ssoCreate' 设置)。

枚举值:

1299

示例值:

first_name

string

可选

用户的名字。不能包含超过5个中文字符。

<= 64 字符

示例值:

Jill

plan_united_type

enum<string>

可选

缩放联合类型。许可证选项:

'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

用户电子邮件地址。

必需

<= 128 字符

示例值:

jchill@example.com

action

enum<string>

必需

创建新用户要采取的操作:

'create'-用户从Zoom收到一封包含确认链接的电子邮件。然后，用户必须使用该链接来激活其Zoom帐户。然后，用户可以设置或更改其密码。

'autoCreate'-此操作适用于具有托管域的企业客户。由于创建不属于您的域的用户涉及安全风险，因此默认情况下禁用此功能。

'custCreate'-使用此操作创建的用户没有密码，并且 ** 不会 ** 具有登录Zoom web门户或Zoom客户端的能力。这些用户仍然可以分别使用 “start_url” 和 “join_url” 主持和加入会议。要使用此选项，您必须联系集成软件供应商 (ISV) 销售团队。

“Ssocreate”-为启用的 “预配置SSO用户” 选项提供此操作。以这种方式创建的用户没有密码。如果 ** 不是 ** 基本用户，则会生成具有预配电子邮件的用户名 (无域) 的个人虚值URL。如果用户名或PMI无效或被占用，则它使用随机数或随机个人虚荣URL。

枚举值:

createautoCreatecustCreatessoCreate

示例值:

create

示例

{
    "user_info": {
        "password": "if42!LfH@",
        "feature": {
            "zoom_one_type": 16,
            "zoom_phone": true
        },
        "last_name": "Chill",
        "display_name": "Jill Chill",
        "type": 1,
        "first_name": "Jill",
        "plan_united_type": "1",
        "email": "jchill@example.com"
    },
    "action": "create"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://prod-cn.your-api-server.com/accounts//users' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_info": {
        "password": "if42!LfH@",
        "feature": {
            "zoom_one_type": 16,
            "zoom_phone": true
        },
        "last_name": "Chill",
        "display_name": "Jill Chill",
        "type": 1,
        "first_name": "Jill",
        "plan_united_type": "1",
        "email": "jchill@example.com"
    },
    "action": "create"
}'

返回响应

🟢201** HTTP状态代码: ** '201' 用户已创建。

application/json

Body

last_name

string

用户的姓氏。

可选

<= 64 字符

示例值:

Chill

string

用户ID。

可选

示例值:

KDcuGIm1QgePTO8WbOqwIQ

type

enum<integer>

可选

用户类型。
'1'-基本。
“2”-许可。
'99' - None (这只能用 'ssoCreate' 设置)。

枚举值:

1299

示例值:

first_name

string

用户的名字。

可选

<= 64 字符

示例值:

Jill

string

用户电子邮件地址。

可选

示例值:

jchill@example.com

示例

{
    "last_name": "Chill",
    "id": "KDcuGIm1QgePTO8WbOqwIQ",
    "type": 1,
    "first_name": "Jill",
    "email": "jchill@example.com"
}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误代码: ** '300' 无效参数: 密码您的帐户无法将 “用户类型” 设置为 “用户类型”。 ** 错误代码: ** '200' 没有特权. 没有权限，请联系Zoom客户支持。 ** 错误代码: ** '1000' 无法更改用户，因为他们是呼叫队列管理员或自动接待员操作员。 ** 错误代码: ** '300' 无法完成您的请求，因为名称包含无效的单词: {name} <b

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '4130' 组不存在: $ groupId ** 错误代码: ** '1102' 您无法启用 “缩放手机” 功能，因为您没有任何可用的许可证。

🟠409** HTTP状态代码: ** '409' 冲突 ** 错误码: ** '1005' 电子邮件 “$ Email” 已被使用。

批量更新功能

列出用户