REST Resource: users

Tài nguyên: Người dùng

Directory API cho phép bạn tạo và quản lý người dùng, bí danh người dùng và ảnh hồ sơ trên Google của người dùng trong tài khoản của mình. Để biết thêm thông tin về các tác vụ thường gặp, hãy xem Hướng dẫn dành cho nhà phát triển về tài khoản người dùng và Hướng dẫn dành cho nhà phát triển về biệt hiệu 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 (UserName)
  },
  "kind": string,
  "etag": string,
  "emails": value,
  "externalIds": value,
  "relations": value,
  "aliases": [
    string
  ],
  "isMailboxSetup": boolean,
  "customerId": string,
  "addresses": value,
  "organizations": value,
  "lastLoginTime": string,
  "phones": value,
  "suspensionReason": string,
  "thumbnailPhotoUrl": string,
  "languages": value,
  "posixAccounts": value,
  "creationTime": string,
  "nonEditableAliases": [
    string
  ],
  "sshPublicKeys": value,
  "notes": value,
  "websites": value,
  "locations": value,
  "includeInGlobalAddressList": boolean,
  "keywords": value,
  "deletionTime": string,
  "gender": value,
  "thumbnailPhotoEtag": string,
  "ims": value,
  "customSchemas": value,
  "isEnrolledIn2Sv": boolean,
  "isEnforcedIn2Sv": boolean,
  "archived": boolean,
  "orgUnitPath": string,
  "recoveryEmail": string,
  "recoveryPhone": string,
  "isGuestUser": boolean,
  "guestAccountInfo": {
    object (GuestAccountInfo)
  }
}
Trường
id

string

Mã nhận dạng duy nhất của người dùng. id có thể được dùng làm userKey của URI yêu cầu của người dùng.
primaryEmail

string

Địa chỉ email chính của người dùng. Bạn phải có thuộc tính này trong yêu cầu tạo tài khoản người dùng. primaryEmail phải là duy nhất và không được là email đại diện của người dùng khác.
password

value (Value format)

Lưu trữ mật khẩu cho tài khoản người dùng. Bạn phải có giá trị mật khẩu của người dùng khi tạo tài khoản người dùng. Đây là thông tin không bắt buộc khi cập nhật người dùng và chỉ được cung cấp nếu người dùng đang 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 phần nội dung phản hồi của API.

Mật khẩu có thể chứa mọi tổ hợp ký tự ASCII và phải có từ 8 đến 100 ký tự.

Bạn nên gửi tham số password dưới dạng giá trị băm được mã hoá thập lục phân và đặt hashFunction cho phù hợp. Nếu bạn chỉ định hashFunction, thì mật khẩu phải là một khoá băm hợp lệ.
hashFunction

string

Lưu trữ định dạng băm của thuộc tính password. Bạn có thể dùng các giá trị hashFunction sau:

  • MD5 – Chấp nhận các giá trị được mã hoá thập lục phân đơn giản.
  • SHA-1 – Chấp nhận các giá trị được mã hoá thập lục phân đơn giản.
  • crypt – Tuân thủ thư viện C crypt. Hỗ trợ các thuật toán băm DES, MD5 (tiền tố băm $1$), SHA-256 (tiền tố băm $5$) và SHA-512 (tiền tố băm $6$).

Nếu được chỉ định trong tiền tố, số vòng phải không quá 10.000.
isAdmin

boolean

Chỉ có đầu ra. Cho biết một người dùng có đặc quyền quản trị viên cấp cao. Bạn chỉ có thể chỉnh sửa tài sản isAdmin trong thao tác Đặt người dùng làm quản trị viên ( phương thức makeAdmin). Nếu được chỉnh sửa trong các phương thức insert hoặc update của người dùng, thì dịch vụ API sẽ bỏ qua nội dung chỉnh sửa.
isDelegatedAdmin

boolean

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.
API hỗ trợ quản trị viên được uỷ quyền nhưng không thể tạo hoặc khôi phục người dùng đã xoá, hoặc chỉ định người dùng làm quản trị viên. Dịch vụ API sẽ bỏ qua những yêu cầu này.
Vai trò và đặc quyền của quản trị viên được chỉ định bằng Bảng điều khiển dành cho quản trị viên.
agreedToTerms

boolean

Chỉ có đầu ra. Thuộc tính này là true nếu người dùng đã hoàn tất lần đăng nhập ban đầu và chấp nhận thoả thuận Điều khoản dịch vụ.
suspended

boolean

Cho biết người dùng có bị tạm ngưng hay không.
changePasswordAtNextLogin

boolean

Cho biết liệu người dùng có bắt 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 thông qua một nhà cung cấp dịch vụ danh tính bên thứ ba.
ipWhitelisted

boolean

Nếu true, địa chỉ IP của người dùng phải tuân theo cấu hình địa chỉ IP allowlist không dùng nữa.
name

object (UserName)

Lưu trữ tên và họ của người dùng, cũng như giá trị fullName chỉ có thể đọc. Số lượng ký tự tối đa trong givenName và trong các giá trị familyName là 60. Ngoài ra, các giá trị tên hỗ trợ ký tự Unicode/UTF-8 và có thể chứa dấu cách, chữ cái (a-z), chữ số (0-9), dấu gạch ngang (-), dấu gạch chéo lên (/) và dấu chấm (.). Để biết thêm thông tin về các quy tắc sử dụng ký tự, hãy xem Trung tâm trợ giúp dành cho Quản trị. Kích thước dữ liệu tối đa được phép cho trường này là 1 KB.
kind

string

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à admin#directory#user.
etag

string

Chỉ có đầu ra. ETag của tài nguyên.
emails

value (Value format)

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.

Trường

emails[].address

string

Địa chỉ email của người dùng. Đây cũng là mã nhận dạng email. Giá trị này có thể là địa chỉ email chính hoặc email đại diện của người dùng.

emails[].customType

string

Nếu địa chỉ email type là custom, thì thuộc tính này chứa giá trị tuỳ chỉnh và bạn phải đặt giá trị này.

emails[].primary

boolean

Cho biết đây có phải là email chính của người dùng hay không. Bạn chỉ có thể đánh dấu một mục là mục chính.

emails[].type

string

Loại tài khoản email. Nếu bạn đặt thành custom, bạn cũng phải đặt customType.

Giá trị được chấp nhận: custom, home, other, work.
externalIds

value (Value format)

Danh sách 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ã nhận dạng mạng. Kích thước dữ liệu tối đa được phép là 2 KB.

Trường

externalIds[].customType

string

Nếu mã nhận dạng bên ngoài type là custom, thì thuộc tính này chứa giá trị tuỳ chỉnh và bạn phải đặt giá trị này.

externalIds[].type

string

Loại mã nhận dạng bên ngoài. Nếu bạn đặt thành custom, bạn cũng phải đặt customType.

Giá trị được chấp nhận: account, custom, customer, login_id, network, organization.

externalIds[].value

string

Giá trị của mã nhận dạng bên ngoài.
relations

value (Value format)

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 cho 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.

Trường

relations[].customType

string

Nếu mối quan hệ type là custom, thì thuộc tính này phải chứa giá trị tuỳ chỉnh và bạn phải đặt thuộc tính này.

relations[].type

string

Loại mối quan hệ. Nếu bạn đặt thành custom, bạn cũng phải đặt customType.

Giá trị được chấp nhận:
  • admin_assistant
  • assistant
  • brother
  • child
  • custom
  • domestic_partner
  • dotted_line_manager
  • exec_assistant
  • father
  • friend
  • manager
  • mother
  • parent
  • partner
  • referred_by
  • relative
  • sister
  • spouse

relations[].value

string

Địa chỉ email của người mà người dùng có quan hệ.
aliases[]

string

Chỉ có đầu ra. Danh sách địa chỉ email đại diện của người dùng.
isMailboxSetup

boolean

Chỉ có đầu ra. Cho biết liệu hộp thư của người dùng trên Google có được tạo hay không. Thuộc tính này chỉ áp dụng nếu người dùng đã được cấp giấy phép Gmail.
customerId

string

Chỉ có đầu ra. Mã khách hàng để truy xuất tất cả người dùng tài khoản.
Bạn có thể dùng email đại diện my_customer để đại diện cho customerId của tài khoản.
Là quản trị viên đại lý, bạn có thể dùng customerId của tài khoản khách hàng mua qua đại lý. Để nhận customerId, hãy sử dụng miền chính của tài khoản trong tham số domain của yêu cầu users.list.
addresses

value (Value format)

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.

Trường

addresses[].country

string

Quốc gia.

addresses[].countryCode

string

Mã quốc gia. Sử dụng tiêu chuẩn ISO 3166-1.

addresses[].customType

string

Nếu địa chỉ type là custom, thì thuộc tính này chứa giá trị tuỳ chỉnh và bạn phải đặt giá trị này.

addresses[].extendedAddress

string

Đối với địa chỉ mở rộng, chẳng hạn như địa chỉ có chứa một tiểu vùng.

addresses[].formatted

string

Địa chỉ bưu chính đầy đủ và không có cấu trúc. Thông tin này không được đồng bộ hoá với các trường địa chỉ có cấu trúc. Bao gồm các thuộc tính sau: địa chỉ đường phố, hộp thư bưu điện, thành phố, tiểu bang/tỉnh, mã bưu chính/mã zip, quốc gia/khu vực.

addresses[].locality

string

Thị trấn hoặc thành phố của địa chỉ.

addresses[].poBox

string

Hòm thư bưu điện (nếu có).

addresses[].postalCode

string

Mã ZIP hoặc mã bưu chính (nếu có).

addresses[].primary

boolean

Nếu đây là địa chỉ chính của người dùng. Danh sách địa chỉ chỉ có thể chứa một địa chỉ chính.

addresses[].region

string

Tỉnh hoặc tiểu bang viết tắt.

addresses[].sourceIsStructured

boolean

Cho biết địa chỉ do người dùng cung cấp có được định dạng hay không. Địa chỉ có định dạng hiện không được hỗ trợ.

addresses[].streetAddress

string

Địa chỉ đường phố, chẳng hạn như 1600 Amphitheatre Parkway. Khoảng trắng trong chuỗi sẽ bị bỏ qua; tuy nhiên, dấu xuống dòng là rất quan trọng.

addresses[].type

string

Loại địa chỉ. Nếu bạn đặt thành custom, bạn cũng phải đặt customType.

Giá trị được chấp nhận: custom, home, other, work.
organizations

value (Value format)

Danh sách các tổ chức mà người dùng thuộc về. Kích thước dữ liệu tối đa cho phép là 10 KB.

Trường

organizations[].costCenter

string

Trung tâm chi phí của tổ chức người dùng.

organizations[].customType

string

Nếu giá trị của loại là tuỳ chỉnh, thì thuộc tính này sẽ chứa loại tuỳ chỉnh.

organizations[].department

string

Chỉ định bộ phận trong tổ chức, chẳng hạn như sales hoặc engineering.

organizations[].description

string

Nội dung mô tả về tổ chức.

organizations[].domain

string

Miền mà tổ chức thuộc về.

organizations[].fullTimeEquivalent

integer

Tỷ lệ phần nghìn tương đương toàn thời gian trong tổ chức (100.000 = 100%).

organizations[].location

string

Vị trí thực tế của tổ chức. Đây không cần phải là một địa chỉ đủ điều kiện.

organizations[].name

string

Tên của tổ chức.

organizations[].primary

boolean

Cho biết đây có phải là tổ chức chính của người dùng hay không. Người dùng chỉ có thể có một tổ chức chính.

organizations[].symbol

string

Ký hiệu chuỗi văn bản của tổ chức. Ví dụ: biểu tượng văn bản của Google là GOOG.

organizations[].title

string

Chức danh của người dùng trong tổ chức. Ví dụ: member hoặc engineer.

organizations[].type

string

Loại tổ chức.

Các giá trị được chấp nhận: domain_only, school, unknown, work.
lastLoginTime

string

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 họ. 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 ở dạng YYYY-MM-DDThh:mm:ssTZD. Ví dụ: 2010-04-05T17:30:04+01:00.
phones

value (Value format)

Danh sách số điện thoại của người dùng. Kích thước dữ liệu tối đa được phép là 1 KB.

Trường

phones[].customType

string

Nếu số điện thoại type là custom, thì thuộc tính này chứa giá trị tuỳ chỉnh và bạn phải đặt giá trị này.

phones[].primary

boolean

Nếu true, thì đây là số điện thoại chính của người dùng. Người dùng chỉ có thể có một số điện thoại chính.

phones[].type

string

Loại số điện thoại. Nếu bạn đặt thành custom, bạn cũng phải đặt customType.

Giá trị được chấp nhận: assistant, callback, car, company_main, custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager.

phones[].value

string

Số điện thoại mà con người có thể đọc được. Số điện thoại có thể ở bất kỳ định dạng nào.
suspensionReason

string

Chỉ có đầu ra. Cho biết lý do 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 suspended là true.
thumbnailPhotoUrl

string

Chỉ có đầu ra. URL của ảnh hồ sơ người dùng. URL có thể là tạm thời hoặc riêng tư.
languages

value (Value format)

Danh sách ngôn ngữ của người dùng. Kích thước dữ liệu tối đa được phép là 1 KB.

Trường

languages[].customLanguage

string

Ngôn ngữ khác. Người dùng có thể cung cấp tên ngôn ngữ của riêng họ nếu không có mã ngôn ngữ ISO 639 tương ứng. Nếu bạn đặt chế độ này, thì bạn không thể đặt languageCode.

languages[].languageCode

string

Giá trị biểu thị ngôn ngữ ở dạng chuỗi theo tiêu chuẩn ISO 639. Hãy xem Mã ngôn ngữ để biết danh sách mã được hỗ trợ. API sẽ chấp nhận các mã ngôn ngữ hợp lệ nằm ngoài bộ được hỗ trợ nhưng có thể dẫn đến hành vi không mong muốn. Các giá trị không hợp lệ gây ra SchemaException. Nếu bạn đặt chế độ này, thì bạn không thể đặt customLanguage.

languages[].preference

string

Không bắt buộc. Nếu có, hãy kiểm soát xem languageCode được chỉ định có phải là ngôn ngữ ưu tiên của người dùng hay không. Nếu bạn đặt customLanguage, thì bạn không thể đặt chế độ này. Giá trị được phép là preferred và not_preferred.
posixAccounts

value (Value format)

Danh sách thông tin tài khoản POSIX của người dùng.

Trường

posixAccounts[].accountId

string

Giá trị nhận dạng trường tài khoản POSIX.

posixAccounts[].gecos

string

GECOS (thông tin người dùng) cho tài khoản này.

posixAccounts[].gid

unsigned long

Mã nhóm mặc định.

posixAccounts[].homeDirectory

string

Đường dẫn đến thư mục chính của tài khoản này.

posixAccounts[].operatingSystemType

string

Loại hệ điều hành cho tài khoản này.

Các giá trị được chấp nhận: linux, unspecified, windows.

posixAccounts[].primary

boolean

Nếu đây là tài khoản chính của người dùng trong SystemId.

posixAccounts[].shell

string

Đường dẫn đến trình bao đăng nhập cho tài khoản này.

posixAccounts[].systemId

string

Giá trị nhận dạng hệ thống mà Tên người dùng hoặc Uid của tài khoản áp dụng.

posixAccounts[].uid

unsigned long

Mã nhận dạng người dùng tuân thủ POSIX.

posixAccounts[].username

string

Tên người dùng của tài khoản.
creationTime

string

Chỉ có đầu ra. Thời điểm tài khoản của người dùng được tạo. 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 ở dạng YYYY-MM-DDThh:mm:ssTZD. Ví dụ: 2010-04-05T17:30:04+01:00.
nonEditableAliases[]

string

Chỉ có đầu ra. Danh sách địa chỉ email đại diện 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

value (Value format)

Danh sách khoá công khai SSH.

Trường

sshPublicKeys[].expirationTimeUsec

long

Thời gian hết hạn tính bằng micrô giây kể từ thời gian bắt đầu của hệ thống.

sshPublicKeys[].fingerprint

string

Dấu vân tay SHA-256 của khoá công khai SSH. (Chỉ đọc)

sshPublicKeys[].key

string

Khoá công khai SSH.
notes

value (Value format)

Ghi chú cho người dùng dưới dạng một đối tượng lồng nhau.

Trường

notes.contentType

string

Loại nội dung của ghi chú, có thể là văn bản thuần tuý hoặc HTML. Mặc định là văn bản thuần tuý.

Giá trị được chấp nhận: text_plain, text_html.

notes.value

string

Nội dung của ghi chú.
websites

value (Value format)

Danh sách các trang web của người dùng.

Trường

websites[].customType

string

Nếu type của trang web là custom, thì thuộc tính này phải chứa giá trị tuỳ chỉnh và phải được đặt.

websites[].primary

boolean

Nếu true, thì đây là trang web chính của người dùng.

websites[].type

string

Loại hoặc mục đích của trang web. Ví dụ: một trang web có thể được gắn nhãn là home hoặc blog. Ngoài ra, một mục có thể có kiểu custom. Nếu bạn đặt thành custom, bạn cũng phải đặt customType.

Giá trị được chấp nhận: app_install_page, blog, custom, ftp, home, home_page, other, profile, reservations, resume, work.

websites[].value

string

URL của trang web.
locations

value (Value format)

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.

Trường

locations[].area

string

Vị trí văn bản. Điều này hữu ích nhất cho mục đích hiển thị để mô tả ngắn gọn vị trí. Ví dụ: Mountain View, CA hoặc Near Seattle.

locations[].buildingId

string

Giá trị nhận dạng toà nhà.

locations[].customType

string

Nếu vị trí type là custom, thì thuộc tính này chứa giá trị tuỳ chỉnh và bạn phải đặt thuộc tính này.

locations[].deskCode

string

Mã văn bản cụ thể nhất của vị trí bàn làm việc riêng lẻ.

locations[].floorName

string

Tên/số tầng.

locations[].floorSection

string

Phần tầng. Vị trí cụ thể hơn trong tầng. Ví dụ: nếu một tầng được chia thành các phần A, B và C, thì trường này sẽ xác định một trong các giá trị đó.

locations[].type

string

Loại vị trí. Nếu bạn đặt thành custom, bạn cũng phải đặt customType.

Giá trị được chấp nhận: custom, default, desk.
includeInGlobalAddressList

boolean

Cho biết liệu hồ sơ người dùng có xuất hiện trong danh sách địa chỉ chung của Google Workspace khi tính năng chia sẻ thông tin liên hệ được bật cho miền hay không. Để 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

value (Value format)

Danh sách từ khoá của người dùng. Kích thước dữ liệu tối đa được phép là 1 KB.

Trường

keywords[].customType

string

Nếu từ khoá type là custom, thì thuộc tính này chứa giá trị tuỳ chỉnh và bạn phải đặt giá trị này.

keywords[].type

string

Mỗi mục nhập có thể có một loại cho biết loại tiêu chuẩn của mục nhập đó.

Ví dụ: từ khoá có thể thuộc loại occupation hoặc outlook. Ngoài loại tiêu chuẩn, một mục có thể có loại custom và bạn có thể đặt tên bất kỳ cho loại này. Nếu bạn đặt thành custom, bạn cũng phải đặt customType.

Giá trị được chấp nhận: custom, mission, occupation, outlook.

keywords[].value

string

Từ khoá.
deletionTime

string

Chỉ có đầu ra. Thời điểm 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 ở dạng YYYY-MM-DDThh:mm:ssTZD. Ví dụ: 2010-04-05T17:30:04+01:00.
gender

value (Value format)

Một đối tượng lồng bên trong 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 cho trường này là 1 KB.

Trường

gender.addressMeAs

string

Một chuỗi ký tự mà con người có thể đọc được, chứa cách thích hợp để con người đề cập đến chủ sở hữu hồ sơ, ví dụ: "anh ấy/anh ấy/của anh ấy" hoặc "họ/họ/của họ".

gender.customGender

string

Tên của một giới tính tuỳ chỉnh.

gender.type

string

 Loại giới tính.

Các giá trị được chấp nhận:
  • female
  • male
  • other
  • unknown

thumbnailPhotoEtag

string

Chỉ có đầu ra. ETag của ảnh người dùng (Chỉ đọc)
ims

value (Value format)

Tài khoản của người dùng trên ứng dụng nhắn tin tức thời (IM). Một tài khoản người dùng có thể có nhiều tài sản ims, nhưng chỉ một trong số các tài sản ims này có thể là thông tin liên hệ chính qua tin nhắn tức thời.

Trường

ims[].customProtocol

string

Nếu giá trị giao thức là custom_protocol, thì thuộc tính này sẽ giữ chuỗi giao thức tuỳ chỉnh.

ims[].customType

string

Nếu type IM là custom, thì thuộc tính này chứa giá trị tuỳ chỉnh và bạn phải đặt giá trị này.

ims[].im

string

Mã nhận dạng mạng nhắn tin tức thời của người dùng.

ims[].primary

boolean

Nếu đây là tin nhắn tức thời chính của người dùng. Chỉ một mục trong danh sách tin nhắn tức thời có thể có giá trị là true.

ims[].protocol

string

 Giao thức IM xác định mạng IM. Giá trị này có thể là mạng tuỳ chỉnh hoặc mạng tiêu chuẩn.

Các giá trị được chấp nhận:
  • aim: Giao thức AOL Instant Messenger
  • custom_protocol: Giao thức mạng IM tuỳ chỉnh
  • gtalk: Giao thức Google Talk
  • icq: Giao thức ICQ
  • jabber: Giao thức Jabber
  • msn: Giao thức MSN Messenger
  • net_meeting: Giao thức Net Meeting
  • qq: Giao thức QQ
  • skype: Giao thức Skype
  • yahoo: Giao thức Yahoo Messenger

ims[].type

string

Loại tài khoản nhắn tin tức thời. Nếu bạn đặt thành custom, bạn cũng phải đặt customType.

Giá trị được chấp nhận: custom, home, other, work.
customSchemas

value (Value format)

Trường tuỳ chỉnh của người dùng. Khoá là schemaName và các giá trị của khoá là 'fieldName': 'field_value'.

  • customSchemas.(key) là một đối tượng lồng ghép.
  • customSchemas.(key).(key) có thể là bất kỳ giá trị nào.
isEnrolledIn2Sv

boolean

Chỉ có đầu ra. Đã đăng ký quy trình xác minh 2 bước (Chỉ đọc)
isEnforcedIn2Sv

boolean

Chỉ có đầu ra. Có thực thi quy trình xác minh 2 bước hay không (Chỉ đọc)
archived

boolean

Cho biết người dùng có được lưu trữ hay không.
orgUnitPath

string

Đườ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 đó sẽ được biểu thị bằng dấu gạch chéo (/).
recoveryEmail

string

Email khôi phục của người dùng.
recoveryPhone

string

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.
isGuestUser

boolean

Không thể thay đổi. Cho biết người dùng có phải là khách hay không.
guestAccountInfo

object (GuestAccountInfo)

Không thể thay đổi. Các trường siêu dữ liệu bổ sung liên quan đến khách

UserName

Biểu diễn dưới dạng JSON 
{
  "fullName": string,
  "familyName": string,
  "givenName": string,
  "displayName": string
}
Trường
fullName

string

Tên đầy đủ của người dùng được tạo bằng cách nối các giá trị tên và họ.
familyName

string

Họ của người dùng. Bắt buộc khi tạo tài khoản người dùng.
givenName

string

Tên của người dùng. Bắt buộc khi tạo tài khoản người dùng.
displayName

string

Tên hiển thị của người dùng. Giới hạn: 256 ký tự.

GuestAccountInfo

Thông tin tài khoản dành riêng cho người dùng Khách.

Biểu diễn dưới dạng JSON 
{
  "primaryGuestEmail": string
}
Trường
primaryGuestEmail

string

Không thể thay đổi. Email bên ngoài của khách.

Phương thức

createGuest

 Tạo người dùng khách có quyền truy cập vào một số tính năng của Workspace.

delete

 Xoá người dùng.

get

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

insert

 Tạo một người dùng.

list

 Truy xuất danh sách phân trang gồm người dùng đã bị xoá hoặc tất cả người dùng trong một miền.

makeAdmin

 Chỉ định vai trò quản trị viên cấp cao cho người dùng.

patch

 Cập nhật người dùng bằng ngữ nghĩa vá.

signOut

 Đă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ọ.

undelete

 Khôi phục người dùng đã bị xoá.

update

 Cập nhật người dùng.

watch

 Theo dõi các thay đổi trong danh sách người dùng.