List users

GET

/users

Users

A Zoom account can have one or more users. Use this API to list users on your account.

Scopes: user:read:admin

Rate Limit Label: Medium

响应示例

{
  "page_count": 1,
  "page_number": 1,
  "page_size": 30,
  "total_records": 1,
  "users": [
    {
      "created_at": "2018-11-15T01:10:08Z",
      "dept": "",
      "email": "mel@jfggdhfhdfj.djfhdsfh",
      "first_name": "Melina",
      "id": "z8yAAAAA8bbbQ",
      "im_group_ids": [
        "Abdsjkfhdhfj"
      ],
      "last_client_version": "4.4.55383.0716(android)",
      "last_login_time": "2019-09-13T21:08:52Z",
      "last_name": "Ghimire",
      "pic_url": "https://lh4.googleusercontent.com/-someurl/photo.jpg",
      "pmi": 581111112,
      "status": "active",
      "timezone": "America/Los_Angeles",
      "type": 2,
      "verified": 1
    }
  ]
}

请求参数

Query 参数

status

enum<string>

可选

User statuses:
active - Users with an active status.
inactive - Users who are deactivated.
pending - Users with a pending status.

枚举值:

activeinactivepending

默认值:

active

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

role_id

string

可选

Unique identifier of the role. Provide this parameter if you would like to filter the response by a specific role. You can retrieve Role IDs from List Roles API.

page_number

string

可选

The page number of the current page in the returned records.

include_fields

string

可选

Provide a value for this field if you would like to see the following attribute in the response of this API call:

custom_attributes: Returns custom attributes that are associated with the user.
host_key: Returns host key of the user.

next_page_token

string

可选

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

返回响应

🟢200**HTTP Status Code:** `200`<br> User list returned.

application/json

Body

next_page_token

string

可选

page_count

integer

可选

The number of pages returned for the request made.

page_number

integer

可选

The page number of the current results.

默认值:

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

total_records

integer

可选

The total number of all the records available across pages.

users

array [object {19}]

可选

List of user objects.

created_at

string <date-time>

可选

The time when user's account was created.

custom_attributes

array [object {3}]

可选

Custom attributes. This field is only returned if users have been assigned custom attributes and if you provided custom_attributes as the value of include_fields query parameter in the API request.

dept

string

可选

Department, if provided by the user.

string

必需

User's email address.

默认值:

john.doe@gmail.com

first_name

string

可选

User's first name.

<= 64 字符

group_ids

array[string]

可选

IDs of groups where the user is a member.

host_key

string

可选

The host key of the user. This field is only returned if users have been assigned a host key and if you provided host_key as the value of include_fields query parameter in the API request.

string

User ID.

可选

im_group_ids

array[string]

可选

IDs of IM directory groups where the user is a member.

last_client_version

string

可选

The last client version that user used to login.

last_login_time

string <date-time>

可选

User's last login time. There is a three-days buffer period for this field. For example, if user first logged in on 2020-01-01 and then logged out and logged in on 2020-01-02, the value of this field will still reflect the login time of 2020-01-01. However, if the user logs in on 2020-01-04, the value of this field will reflect the corresponding login time since it exceeds the three-day buffer period.

last_name

string

可选

User's last name.

<= 64 字符

plan_united_type

string

可选

This field is returned if the user is enrolled in the Zoom United plan.

pmi

integer <int64>

可选

Personal meeting ID of the user.

role_id

string

可选

Unique identifier of the role assigned to the user.

status

string

可选

User's status

示例值:

active

timezone

string

可选

The time zone of the user.

type

integer

必需

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

示例值:

verified

integer

可选

Display whether the user's email address for the Zoom account is verified or not.
1 - Verified user email.
0 - User's email not verified.

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

Switch a user's account

Create users