Method: users.list

Truy xuất danh sách phân trang gồm những người dùng đã xoá hoặc tất cả người dùng trong một miền.

Yêu cầu HTTP

GET https://admin.googleapis.com/admin/directory/v1/users

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Thông số
customFieldMask

string

Danh sách tên giản đồ được phân tách bằng dấu phẩy. Tất cả các trường trong các giản đồ này đều được tìm nạp. Bạn chỉ nên đặt giá trị này khi projection=custom.
customer

string

Mã nhận dạng duy nhất cho tài khoản Google Workspace của khách hàng. Trong trường hợp tài khoản nhiều miền, để tìm nạp tất cả người dùng cho một khách hàng, hãy sử dụng trường này thay vì domain. Bạn cũng có thể sử dụng bí danh my_customer để đại diện cho customerId của tài khoản. customerId cũng được trả về trong tài nguyên Người dùng. Bạn phải cung cấp tham số customer hoặc domain.
domain

string

Tên miền. Sử dụng trường này để chỉ lấy người dùng từ một miền. Để trả về tất cả miền cho một tài khoản khách hàng, hãy sử dụng tham số truy vấn customer. Bạn phải cung cấp tham số customer hoặc domain.
event

enum (Event)

Sự kiện mà người dùng muốn đăng ký (nếu đăng ký)
maxResults

integer

Số lượng kết quả tối đa cần trả về.
orderBy

enum (OrderBy)

Thuộc tính để sử dụng cho việc sắp xếp kết quả.
pageToken

string

Mã thông báo để chỉ định trang tiếp theo trong danh sách. Mã thông báo trang chỉ có hiệu lực trong 3 ngày.
projection

enum (Projection)

Nhóm nhỏ các trường cần tìm nạp cho người dùng này.
query

string

Chuỗi truy vấn để tìm kiếm các trường của người dùng. Để biết thêm thông tin về cách tạo cụm từ tìm kiếm của người dùng, hãy xem phần Tìm kiếm người dùng.
showDeleted

string

Nếu được đặt thành true, sẽ truy xuất danh sách người dùng đã bị xoá. (Mặc định: false)
sortOrder

enum (SortOrder)

Liệu có trả về kết quả theo thứ tự tăng dần hay giảm dần, không phân biệt chữ hoa chữ thường.
viewType

enum (ViewType)

Liệu có tìm nạp chế độ xem công khai trên toàn miền dành cho quản trị viên hoặc chế độ xem công khai trên toàn miền dành cho người dùng hay không. Để biết thêm thông tin, hãy xem bài viết Truy xuất người dùng khi không phải là quản trị viên.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Trường
kind

string

Loại tài nguyên này.
trigger_event

string

Sự kiện đã kích hoạt phản hồi này (chỉ dùng trong trường hợp Phản hồi đẩy)
etag

string

ETag của tài nguyên.
users[]

object (User)

Danh sách các đối tượng người dùng.
nextPageToken

string

Mã thông báo dùng để truy cập trang tiếp theo của kết quả này. Mã thông báo trang chỉ có hiệu lực trong 3 ngày.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

Sự kiện

Loại sự kiện Subscription

Enum
ADD Sự kiện do người dùng tạo
DELETE Sự kiện do người dùng xoá
MAKE_ADMIN Sự kiện thay đổi trạng thái quản trị viên của người dùng
UNDELETE Sự kiện huỷ xoá người dùng
UPDATE Sự kiện người dùng đã cập nhật

OrderBy

Enum
EMAIL Email chính của người dùng.
FAMILY_NAME Họ của người dùng.
GIVEN_NAME Tên của người dùng.

Dự đoán

Enum
BASIC Không thêm trường tuỳ chỉnh nào cho người dùng.
CUSTOM Bao gồm các trường tuỳ chỉnh từ các giản đồ được yêu cầu trong customFieldMask.
FULL Bao gồm tất cả các trường liên kết với người dùng này.

SortOrder

Enum
ASCENDING Thứ tự tăng dần.
DESCENDING Thứ tự giảm dần.

ViewType

Enum
admin_view Kết quả bao gồm cả các trường chỉ dành cho quản trị viên và các trường công khai trong miền cho người dùng.
domain_public Kết quả chỉ bao gồm các trường cho người dùng mà người dùng khác trong miền có thể xem công khai.