Tài nguyên: Người dùng
API thư mục cho phép bạn tạo và quản lý người dùng, bí danh của người dùng cũng như ảnh hồ sơ của người dùng trên Google. Để biết thêm thông tin về các tác vụ phổ biến, hãy xem Hướng dẫn dành cho nhà phát triển tài khoản người dùng và Hướng dẫn dành cho nhà phát triển về bí danh người dùng.
Biểu diễn dưới dạng JSON |
---|
{
"id": string,
"primaryEmail": string,
"password": value,
"hashFunction": string,
"isAdmin": boolean,
"isDelegatedAdmin": boolean,
"agreedToTerms": boolean,
"suspended": boolean,
"changePasswordAtNextLogin": boolean,
"ipWhitelisted": boolean,
"name": {
object ( |
Các trường | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
Mã nhận dạng duy nhất của người dùng. Người dùng |
||||||||||||||||||||||||||||||||||||||||||
primaryEmail |
Địa chỉ email chính của người dùng. Thuộc tính này là bắt buộc trong yêu cầu tạo tài khoản người dùng. |
||||||||||||||||||||||||||||||||||||||||||
password |
Lưu trữ mật khẩu của tài khoản người dùng. Giá trị mật khẩu của người dùng là bắt buộc khi tạo tài khoản người dùng. Không bắt buộc phải cung cấp thông tin này khi cập nhật người dùng và chỉ nên cung cấp thông tin này nếu người dùng cập nhật mật khẩu tài khoản của họ. Giá trị mật khẩu không bao giờ được trả về trong nội dung phản hồi của API. |
||||||||||||||||||||||||||||||||||||||||||
hashFunction |
Lưu trữ định dạng hàm băm của thuộc tính
Nếu vòng được chỉ định như một phần của tiền tố, thì số vòng đó phải từ 10.000 trở xuống. |
||||||||||||||||||||||||||||||||||||||||||
isAdmin |
Chỉ có đầu ra. Cho biết người dùng có đặc quyền của quản trị viên cấp cao. Bạn chỉ có thể chỉnh sửa thuộc tính |
||||||||||||||||||||||||||||||||||||||||||
isDelegatedAdmin |
Chỉ có đầu ra. Cho biết người dùng có phải là quản trị viên được uỷ quyền hay không. |
||||||||||||||||||||||||||||||||||||||||||
agreedToTerms |
Chỉ có đầu ra. Tài sản này là |
||||||||||||||||||||||||||||||||||||||||||
suspended |
Cho biết người dùng có bị tạm ngưng hay không. |
||||||||||||||||||||||||||||||||||||||||||
changePasswordAtNextLogin |
Cho biết liệu người dùng có bị buộc phải thay đổi mật khẩu vào lần đăng nhập tiếp theo hay không. Chế độ cài đặt này không áp dụng khi người dùng đăng nhập qua một nhà cung cấp danh tính bên thứ ba. |
||||||||||||||||||||||||||||||||||||||||||
ipWhitelisted |
Nếu là |
||||||||||||||||||||||||||||||||||||||||||
name |
Lưu giữ họ và tên đã cho của người dùng cùng giá trị |
||||||||||||||||||||||||||||||||||||||||||
kind |
Chỉ có đầu ra. Loại tài nguyên API. Đối với tài nguyên Người dùng, giá trị là |
||||||||||||||||||||||||||||||||||||||||||
etag |
Chỉ có đầu ra. ETag của tài nguyên. |
||||||||||||||||||||||||||||||||||||||||||
emails |
Danh sách địa chỉ email của người dùng. Kích thước dữ liệu tối đa cho phép là 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
externalIds |
Danh sách các mã nhận dạng bên ngoài của người dùng, chẳng hạn như mã nhân viên hoặc mã mạng. Kích thước dữ liệu tối đa cho phép là 2KB.
|
||||||||||||||||||||||||||||||||||||||||||
relations |
Danh sách mối quan hệ của người dùng với những người dùng khác. Kích thước dữ liệu tối đa được phép của trường này là 2 KB. Để biết thêm thông tin, hãy xem bài viết Quản lý tài khoản người dùng.
|
||||||||||||||||||||||||||||||||||||||||||
aliases[] |
Chỉ có đầu ra. Danh sách địa chỉ email đại diện của người dùng. |
||||||||||||||||||||||||||||||||||||||||||
isMailboxSetup |
Chỉ có đầu ra. Cho biết liệu hộp thư Google của người dùng đã được tạo hay chưa. Tài sản này chỉ áp dụng nếu người dùng đã được cấp giấy phép của Gmail. |
||||||||||||||||||||||||||||||||||||||||||
customerId |
Chỉ có đầu ra. Mã khách hàng để truy xuất tất cả người dùng tài khoản. |
||||||||||||||||||||||||||||||||||||||||||
addresses |
Danh sách địa chỉ của người dùng. Kích thước dữ liệu tối đa cho phép là 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
organizations |
Danh sách các tổ chức mà người dùng là thành viên. Kích thước dữ liệu tối đa cho phép là 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
lastLoginTime |
Chỉ có đầu ra. Lần gần đây nhất người dùng đăng nhập vào tài khoản của người dùng. Giá trị này ở định dạng ngày và giờ ISO 8601. Thời gian là ngày đầy đủ cùng với giờ, phút và giây theo biểu mẫu |
||||||||||||||||||||||||||||||||||||||||||
phones |
Danh sách số điện thoại của người dùng. Kích thước dữ liệu tối đa cho phép là 1KB.
|
||||||||||||||||||||||||||||||||||||||||||
suspensionReason |
Chỉ có đầu ra. Có lý do khiến tài khoản người dùng bị quản trị viên hoặc Google tạm ngưng tại thời điểm tạm ngưng. Thuộc tính này chỉ được trả về nếu thuộc tính |
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoUrl |
Chỉ có đầu ra. URL ảnh hồ sơ của người dùng. URL đó có thể là tạm thời hoặc riêng tư. |
||||||||||||||||||||||||||||||||||||||||||
languages |
Danh sách ngôn ngữ của người dùng. Kích thước dữ liệu tối đa cho phép là 1KB.
|
||||||||||||||||||||||||||||||||||||||||||
posixAccounts |
Danh sách thông tin tài khoản POSIX của người dùng.
|
||||||||||||||||||||||||||||||||||||||||||
creationTime |
Chỉ có đầu ra. Thời điểm tạo tài khoản của người dùng. Giá trị này ở định dạng ngày và giờ ISO 8601. Thời gian là ngày đầy đủ cùng với giờ, phút và giây theo biểu mẫu |
||||||||||||||||||||||||||||||||||||||||||
nonEditableAliases[] |
Chỉ có đầu ra. Danh sách địa chỉ email bí danh không thể chỉnh sửa của người dùng. Các miền này thường nằm ngoài miền chính hoặc miền phụ của tài khoản. |
||||||||||||||||||||||||||||||||||||||||||
sshPublicKeys |
Danh sách khoá công khai SSH.
|
||||||||||||||||||||||||||||||||||||||||||
notes |
Ghi chú cho người dùng dưới dạng đối tượng được lồng.
|
||||||||||||||||||||||||||||||||||||||||||
websites |
Danh sách trang web của người dùng.
|
||||||||||||||||||||||||||||||||||||||||||
locations |
Danh sách vị trí của người dùng. Kích thước dữ liệu tối đa cho phép là 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
includeInGlobalAddressList |
Cho biết liệu hồ sơ của người dùng có xuất hiện trong danh sách địa chỉ chung trên Google Workspace hay không khi tính năng chia sẻ người liên hệ được bật cho miền. Để biết thêm thông tin về cách loại trừ hồ sơ người dùng, hãy xem trung tâm trợ giúp quản trị. |
||||||||||||||||||||||||||||||||||||||||||
keywords |
Danh sách từ khoá của người dùng. Kích thước dữ liệu tối đa cho phép là 1KB.
|
||||||||||||||||||||||||||||||||||||||||||
deletionTime |
Chỉ có đầu ra. Thời gian tài khoản của người dùng bị xoá. Giá trị này ở định dạng ngày và giờ ISO 8601. Thời gian là ngày đầy đủ cùng với giờ, phút và giây theo biểu mẫu |
||||||||||||||||||||||||||||||||||||||||||
gender |
Một đối tượng lồng ghép có chứa giới tính của người dùng. Kích thước dữ liệu tối đa được phép đối với trường này là 1KB.
|
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoEtag |
Chỉ có đầu ra. ETag ảnh của người dùng (Chỉ đọc) |
||||||||||||||||||||||||||||||||||||||||||
ims |
Tài khoản Instant Messenger (IM) của người dùng. Một tài khoản người dùng có thể có nhiều thuộc tính
|
||||||||||||||||||||||||||||||||||||||||||
customSchemas |
Trường tuỳ chỉnh của người dùng. Khoá là
|
||||||||||||||||||||||||||||||||||||||||||
isEnrolledIn2Sv |
Chỉ có đầu ra. Đã đăng ký xác minh 2 bước (Chỉ đọc) |
||||||||||||||||||||||||||||||||||||||||||
isEnforcedIn2Sv |
Chỉ có đầu ra. Có thực thi xác minh 2 bước không (Chỉ đọc) |
||||||||||||||||||||||||||||||||||||||||||
archived |
Cho biết người dùng có được lưu trữ hay không. |
||||||||||||||||||||||||||||||||||||||||||
orgUnitPath |
Đường dẫn đầy đủ của tổ chức mẹ được liên kết với người dùng. Nếu tổ chức mẹ là cấp cao nhất, thì tổ chức đó được thể hiện dưới dạng dấu gạch chéo lên ( |
||||||||||||||||||||||||||||||||||||||||||
recoveryEmail |
Email khôi phục của người dùng. |
||||||||||||||||||||||||||||||||||||||||||
recoveryPhone |
Số điện thoại khôi phục của người dùng. Số điện thoại phải ở định dạng E.164, bắt đầu bằng dấu cộng (+). Ví dụ: +16506661212. |
UserName
Biểu diễn dưới dạng JSON |
---|
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string } |
Các trường | |
---|---|
fullName |
Họ và tên của người dùng được tạo bằng cách nối các giá trị họ và tên. |
familyName |
Họ của người dùng. Bắt buộc khi tạo tài khoản người dùng. |
givenName |
Tên của người dùng. Bắt buộc khi tạo tài khoản người dùng. |
displayName |
Tên hiển thị của người dùng. Giới hạn: 256 ký tự. |
Phương thức |
|
---|---|
|
Xoá người dùng. |
|
Truy xuất người dùng. |
|
Tạo người dùng. |
|
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. |
|
Đặt người dùng làm quản trị viên cấp cao. |
|
Cập nhật người dùng bằng cách sử dụng ngữ nghĩa bản vá. |
|
Đăng xuất người dùng khỏi tất cả các phiên trên web và thiết bị, đồng thời đặt lại cookie đăng nhập của họ. |
|
Khôi phục người dùng đã bị xoá. |
|
Cập nhật người dùng. |
|
Theo dõi các thay đổi trong danh sách người dùng. |