Create users

POST

/users

Users

A Zoom account can have one or more users. Use this API to add a new user to your account.

Prerequisites:

Pro or higher plan

Scopes: user:write:admin user:write

Rate Limit Label: Light

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://api.zoom.us/v2/users' \
--form 'action=""'

响应示例

201 - response

{
  "email": "string",
  "first_name": "string",
  "id": "string",
  "last_name": "string",
  "type": "integer"
}

请求参数

Body 参数multipart/form-data

action

enum<string>

必需

Specify how to create the new user:
create - User will get an email sent from Zoom. There is a confirmation link in this email. The user will then need to use the link to activate their Zoom account. The user can then set or change their password.
autoCreate - This action is provided for the enterprise customer who has a managed domain. This feature is disabled by default because of the security risk involved in creating a user who does not belong to your domain.
custCreate - Users created via this option do not have passwords and will not have the ability to log into the Zoom Web Portal or the Zoom Client. These users can still host and join meetings using the start_url and join_url respectively. To use this option, you must contact the ISV Platform Sales team at isv@zoom.us.
ssoCreate - This action is provided for the enabled “Pre-provisioning SSO User” option. A user created in this way has no password. If not a basic user, a personal vanity URL using the user name (no domain) of the provisioning email will be generated. If the user name or PMI is invalid or occupied, it will use a random number or random personal vanity URL.

枚举值:

createautoCreatecustCreatessoCreate

user_info

object

可选

string

必需

User email address.

<= 128 字符

first_name

string

可选

User's first name: cannot contain more than 5 Chinese words.

<= 64 字符

last_name

string

可选

User's last name: cannot contain more than 5 Chinese words.

<= 64 字符

password

string <password>

可选

User password. Only used for the "autoCreate" function. The password has to have a minimum of 8 characters and maximum of 32 characters. By default (basic requirement), password must have at least one letter (a, b, c..), at least one number (1, 2, 3...) and include both uppercase and lowercase letters. It should not contain only one identical character repeatedly ('11111111' or 'aaaaaaaa') and it cannot contain consecutive characters ('12345678' or 'abcdefgh').

Note: If the account owner or admin has enabled enhanced password requirements, the value provided in this field must meet those requirements. These requirements can be retrieved by calling the Get Account Settings API and referring to the password_requirement field present in the security object.

>= 8 字符<= 32 字符

type

enum<integer>

必需

User type:
1 - Basic.
2 - Licensed.
3 - On-prem.
99 - None (this can only be set with ssoCreate).

枚举值:

12399

返回响应

🟢201**HTTP Status Code:** `201` User created.

application/json

Body

string

可选

User email address.

first_name

string

可选

User's first name.

<= 64 字符

string

User ID.

可选

last_name

string

可选

User's last name.

<= 64 字符

type

enum<integer>

可选

User type:
1 - Basic.
2 - Licensed.
3 - On-prem.
99 - None (this can only be set with ssoCreate).

枚举值:

12399

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `300` Invalid parameter: password **Error Code:** `200` No privilege. No permission, please contact Zoom customer support. **Error Code:** `1000` The user ca

🟠404**HTTP Status Code:** `404` **Not Found** **Error Code:** `4130` Group does not exist: $groupId

🟠409**HTTP Status Code:** `409` User with that email already exists **Error Code:** `1005` Email $email has already been used.

修改于 2024-04-24 09:06:48

List users

Check a user email