Truy xuất danh sách được phân trang có chứa người dùng đã bị xóa hoặc tất cả người dùng trong 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
Các tham số | |
---|---|
customFieldMask |
Danh sách tên giản đồ được phân tách bằng dấu phẩy. Hệ thống sẽ tìm nạp tất cả các trường trong những lược đồ này. Bạn chỉ nên đặt giá trị 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. Trong trường hợp tài khoản nhiều miền, để tìm nạp tất cả các nhóm cho một khách hàng, hãy sử dụng trường này thay vì |
domain |
Tên miền. Sử dụng trường này để nhận nhóm từ chỉ một miền. Để trả lại tất cả tên miền cho tài khoản khách hàng, thay vào đó hãy sử dụng tham số truy vấn |
event |
Sự kiện dự định sẽ đăng ký (nếu có đăng ký) |
maxResults |
Số kết quả tối đa cần trả về. |
orderBy |
Thuộc tính 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 để tìm nạp cho người dùng này. |
query |
Chuỗi truy vấn để tìm kiếm các trường người dùng. Để biết thêm thông tin về cách xây dựng 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 thành |
sortOrder |
Trả lại 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 |
Có tìm nạp chế độ xem công khai trên toàn miền hoặc 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 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 ( |
Các trường | |
---|---|
kind |
Đây chính là loại tài nguyên. |
trigger_event |
Sự kiện đã kích hoạt phản hồi này (chỉ được sử dụng trong trường hợp Phản hồi đẩy) |
etag |
ETag của tài nguyên. |
users[] |
Danh sách đối tượng người dùng. |
nextPageToken |
Mã thông báo dùng để truy cập vào trang tiếp theo của kết quả này. |
Phạm vi ủy 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 ủy quyền.
Event (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 đã xóa người dùng |
MAKE_ADMIN |
Sự kiện thay đổi trạng thái quản trị viên người dùng |
UNDELETE |
Sự kiện người dùng chưa bị xóa |
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 do người dùng cung cấp. |
Dự đoán
Enum | |
---|---|
BASIC |
Không bao gồm bất kỳ trường tùy chỉnh nào cho người dùng. |
CUSTOM |
Bao gồm các trường tùy chỉnh từ giản đồ được yêu cầu trong customFieldMask . |
FULL |
Bao gồm tất cả các trường được 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. |
Loại khung hiển thị
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 của miền cho người dùng. |
domain_public |
Kết quả chỉ bao gồm các trường của người dùng hiển thị công khai với người dùng khác trong miền. |