Method: users.list

Truy xuất danh sách được phân trang của người dùng đã bị 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

Tham 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 thuộc tính này khi projection=custom.
customer

string

Mã nhận dạng duy nhất của tài khoản Google Workspace của khách hàng. Đối với 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 cho 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 của mình. 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ỉ nhận người dùng từ một miền. Để trả về tất cả cá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à gói thuê bao dự kiến (nếu là người đăng ký)
maxResults

integer

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

enum (OrderBy)

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

string

Mã thông báo để chỉ định trang tiếp theo trong danh sách
projection

enum (Projection)

Những nhóm trường nào 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ề việc tạo truy vấn của người dùng, hãy xem phần Tìm kiếm người dùng.
showDeleted

string

Nếu bạn đặt chính sách này thành true, hệ thống 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 sẽ tìm nạp chế độ xem công khai của người dùng trên toàn miền hay chỉ dành cho quản trị viên. Để biết thêm thông tin, hãy xem phần Truy xuất người dùng với tư cách không phải 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

Đó là một loại tài nguyên.
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 đối tượng người dùng.
nextPageToken

string

Mã thông báo được dùng để truy cập vào trang tiếp theo của kết quả nà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 Đăng ký

Enum
ADD Sự kiện do người dùng tạo
DELETE Sự kiện bị 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 được huỷ xoá của người dùng
UPDATE Sự kiện do người dùng cập nhật

Sắp xếp theo

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 được thêm trường tuỳ chỉnh nào cho người dùng.
CUSTOM Bao gồm các trường tùy 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ả trường chỉ dành cho quản trị viên và 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 dành cho người dùng được hiển thị công khai với những người dùng khác trong miền.