Truy xuất danh sách được phân trang gồm những 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 |
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 những giản đồ này đều được tìm nạp. Bạn chỉ nên đặt thuộc tính này khi |
customer |
Mã nhận dạng duy nhất cho 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ả các nhóm cho khách hàng, hãy sử dụng trường này thay cho |
domain |
Tên miền. Sử dụng trường này để nhận các nhóm chỉ 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 |
event |
Sự kiện dự định sử dụng gói thuê bao (nếu đăng ký) |
maxResults |
Số kết quả tối đa cần trả về. |
orderBy |
Thuộc tính sử dụng để sắp xếp kết quả. |
pageToken |
Mã thông báo để chỉ định trang tiếp theo trong danh sách |
projection |
Tập hợp con các trường cần tìm nạp cho người dùng này. |
query |
Chuỗi truy vấn để tìm kiếm trường người dùng. Để biết thêm thông tin về cách tạo truy vấn của người dùng, hãy xem Tìm kiếm người dùng. |
showDeleted |
Nếu bạn đặt chính sách này thành |
sortOrder |
Liệu có trả về kết quả theo thứ tự tăng dần hay giảm dần hay không, không phân biệt chữ hoa chữ thường. |
viewType |
Liệu có tìm nạp chế độ xem công khai trên toàn miền hay chỉ dành cho quản trị viên của người dùng hay không. Để biết thêm thông tin, hãy xem phần Truy xuất người dùng với tư cách là người 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 ( |
Trường | |
---|---|
kind |
Đây là loại tài nguyên. |
trigger_event |
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 |
Thẻ ETag của tài nguyên. |
users[] |
Danh sách đối tượng người dùng. |
nextPageToken |
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 đây:
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 bài viết Hướng dẫn uỷ quyền.
Sự kiện
Loại sự kiện Gói thuê bao
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 đã hủy xóa của người dùng |
UPDATE |
Sự kiện do 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ự kiến
Enum | |
---|---|
BASIC |
Đừng thêm trường tuỳ chỉnh cho người dùng. |
CUSTOM |
Bao gồm các trường tuỳ chỉnh trong 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 dành 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 mà những người dùng khác trong miền đó nhìn thấy công khai. |