Method: users.get

Truy xuất người dùng.

Yêu cầu HTTP

GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}

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

Tham số đường dẫn

Tham số
userKey

string

Xác định người dùng trong yêu cầu API. Giá trị này có thể là địa chỉ email chính, địa chỉ email đại diện hoặc mã nhận dạng người dùng duy nhất của người dùng.

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 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 projection=custom.

projection

enum (Projection)

Tập hợp con các trường cần tìm nạp cho người dùng này.

viewType

enum (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, nội dung phản hồi sẽ chứa một phiên bản của User.

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

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

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.

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.