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, email đại diện 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ụ phổ biến, 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ề 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 (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
}
Trường
id

string

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

string

Địa chỉ email chính của người dùng. Bạn phải cung cấp 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à bí danh 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 nhập giá trị mật khẩu của người dùng 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 nếu người dùng cập nhật mật khẩu của tài khoản. Giá trị mật khẩu không bao giờ được trả về trong nội dung phản hồi của API.

Mật khẩu có thể chứa bất kỳ tổ hợp ký tự ASCII nào 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á theo hệ thập lục phân và đặt hashFunction cho phù hợp. Nếu bạn chỉ định hashFunction, mật khẩu phải là khoá băm hợp lệ.
hashFunction

string

Lưu trữ định dạng băm của thuộc tính password. Giá trị hashFunction sau được phép:

  • MD5 – Chấp nhận các giá trị được mã hoá theo hệ thập lục phân đơn giản.
  • SHA-1 – Chấp nhận các giá trị được mã hoá theo hệ thập lục phân đơn giản.
  • crypt – Tương thích với thư viện mật mã C. 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ác vòng được chỉ định dưới dạng một phần của tiền tố, thì các vòng phải từ 10.000 trở xuống.
isAdmin

boolean

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 isAdmin trong thao tác Chỉ định người dùng làm quản trị viên ( phương thức makeAdmin). Nếu được chỉnh sửa trong phương thức chèn hoặc cập nhật 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 ủy quyền hay không.
Quản trị viên được ủy quyền được API hỗ trợ nhưng không thể tạo hoặc hủy xóa người dùng hoặc đặt người dùng làm quản trị viên. Dịch vụ API sẽ bỏ qua các 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. Tài sản này là true nếu người dùng đã hoàn tất lần đăng nhập đầu tiên và chấp nhận thoả thuận về Điều khoản dịch vụ.
suspended

boolean

Cho biết liệu 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 danh tính bên thứ ba.
ipWhitelisted

boolean

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

object (UserName)

Lưu giữ họ và tên cụ thể của người dùng cùng với 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ợ các ký tự Unicode/UTF-8 và có thể chứa dấu cách, chữ cái (a-z), 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ề quy tắc sử dụng ký tự, hãy xem trung tâm trợ giúp quản trị. Kích thước dữ liệu tối đa được phép cho trường này là 1KB.
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à 10KB.

Trường

emails[].address

string

Địa chỉ email của người dùng. Đồng thời đóng vai trò là mã 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à phải được đặt.

emails[].primary

boolean

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

emails[].type

string

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

Các giá trị có thể chấp nhận: custom, home, other, work.
externalIds

value (Value format)

Danh sách mã nhận dạng bên ngoài cho người dùng, chẳng hạn như mã nhận dạng nhân viên hoặc mã mạng. Kích thước dữ liệu tối đa cho phép là 2KB.

Trường

externalIds[].customType

string

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

externalIds[].type

string

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

Các 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ệ giữ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à 2KB. Để biết thêm thông tin, hãy xem phần 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, thuộc tính này chứa giá trị tuỳ chỉnh và phải được đặt.

relations[].type

string

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

Các giá trị có thể 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 có liên quan đến người dùng.
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 hộp thư Google của người dùng 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ể sử dụng bí danh my_customer để đại diện cho customerId của tài khoản.
Là quản trị viên của đại lý, bạn có thể sử dụng customerId của tài khoản khách hàng được bán lại. Để 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à 10KB.

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, thuộc tính này chứa giá trị tùy chỉnh và phải được đặt.

addresses[].extendedAddress

string

Đối với những đị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. Địa chỉ 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ố, P.O. hộp, thành phố, tiểu bang/tỉnh, ZIP/mã bưu chính, quốc gia/khu vực.

addresses[].locality

string

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

addresses[].poBox

string

Hộp 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 định dạng hay chưa. Nhữ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. Hệ thống sẽ bỏ qua khoảng trắng trong chuỗi; tuy nhiên, những dòng mới rất quan trọng.

addresses[].type

string

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

Các giá trị có thể chấp nhận: custom, home, other, work.
organizations

value (Value format)

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

Trường

organizations[].costCenter

string

Trung tâm chi phí trong tổ chức của 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 phòng ban 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 của tổ chức.

organizations[].fullTimeEquivalent

integer

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

organizations[].location

string

Vị trí thực tế của tổ chức. Đây không cần phải là đị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. Một người dùng chỉ có thể có một tổ chức chính.

organizations[].symbol

string

Biểu tượng 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.

Giá trị có thể chấp nhận: domain_only, school, unknown, work.
lastLoginTime

string

Chỉ có đầu ra. Lần cuối cùng người dùng đăng nhập vào tài khoản của người dùng. Giá trị có đị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 cho phép là 1KB.

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à phải được đặt.

phones[].primary

boolean

Nếu là true, đây sẽ là số điện thoại chính của người dùng. Mỗi 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 đặt thành custom thì bạn cũng phải đặt customType.

Các giá trị có thể 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, work_fax, work, work_fax.work_mobilework_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 số điện thoại nào.
suspensionReason

string

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 suspended là true.
thumbnailPhotoUrl

string

Chỉ có đầu ra. URL ảnh hồ sơ của người dùng. URL này 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 cho phép là 1KB.

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 mình nếu không có mã ngôn ngữ tương ứng theo tiêu chuẩn ISO 639. Nếu đặt giá trị này, bạn sẽ không thể đặt languageCode.

languages[].languageCode

string

Biểu thị một ngôn ngữ dạng chuỗi theo ISO 639. Xem phần Mã ngôn ngữ để biết danh sách các mã được hỗ trợ. API sẽ chấp nhận mã ngôn ngữ hợp lệ ngoài nhóm đượ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 đặt giá trị này, bạn sẽ không thể đặt customLanguage.

languages[].preference

string

Không bắt buộc. Nếu có, hãy kiểm soát việc 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 đã đặt customLanguage, bạn sẽ không thể thiết lập chế độ cài đặt này. Các 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 của 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 gốc của tài khoản này.

posixAccounts[].operatingSystemType

string

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

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 màn hình đăng nhập cho tài khoản này.

posixAccounts[].systemId

string

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

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 gian tài khoản của người dùng được tạo. Giá trị có đị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

Tệp tham chiếu 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 đối tượng được lồng.

Trường

notes.contentType

string

Loại nội dung ghi chú, 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 ghi chú.
websites

value (Value format)

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

Trường

websites[].customType

string

Nếu trang web 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ị đó.

websites[].primary

boolean

Nếu giá trị trả về là true, đây sẽ 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 nhập có thể có loại custom. Nếu đặt thành custom thì bạn cũng phải đặt customType.

Các giá trị có thể 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à 10KB.

Trường

locations[].area

string

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

locations[].buildingId

string

Mã nhận dạng toà nhà.

locations[].customType

string

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

locations[].deskCode

string

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

locations[].floorName

string

Tên/số tầng.

locations[].floorSection

string

Phần tầng. Vị trí cụ thể hơn bên trong tầng. Ví dụ: nếu sàn đượ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 đặt là custom, thì bạn cũng phải đặt customType.

Các giá trị có thể chấp nhận: custom, default, desk.
includeInGlobalAddressList

boolean

Cho biết liệu hồ sơ của người dùng có hiển thị trong danh sách địa chỉ chung của Google Workspace hay không khi tính năng chia sẻ thông tin 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 dành cho quản trị viên.
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 cho phép là 1KB.

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à phải được đặt.

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ục nhập có thể có loại custom và có thể đặt bất kỳ tên nào cho mục nhập đó. Nếu đặt là custom, thì bạn cũng phải đặt customType.

Các giá trị có thể 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ị có đị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 được lồng 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 cho trường này là 1KB.

Trường

gender.addressMeAs

string

Chuỗi ký tự mà con người đọc được có chứa cách thích hợp để con người tham chiếu đến chủ sở hữu hồ sơ, chẳng hạn như "người đó" hoặc "họ/họ".

gender.customGender

string

Tên của giới tính tùy chỉnh.

gender.type

string

 Loại giới tính.

Giá trị có thể 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 Trình nhắn tin nhanh (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 ims, nhưng chỉ một trong các thuộc tính ims này có thể là người liên hệ IM chính.

Trường

ims[].customProtocol

string

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

ims[].customType

string

Nếu IM type là custom, thuộc tính này chứa giá trị tùy chỉnh và phải được đặt.

ims[].im

string

Mã mạng nhắn tin nhanh của người dùng.

ims[].primary

boolean

Nếu đây là IM chính của người dùng. Chỉ một mục nhập trong danh sách IM 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 chuẩn.

Giá trị có thể chấp nhận:
  • aim: Giao thức Trình gửi tin nhắn nhanh AOL
  • custom_protocol: Giao thức mạng IM tùy 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 Meetings
  • qq: Giao thức QQ
  • skype: Giao thức của Skype
  • yahoo: Giao thức Yahoo Messenger

ims[].type

string

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

Các giá trị có thể 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à giá trị của khoá là 'fieldName': 'field_value'.

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

boolean

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

boolean

Chỉ có đầu ra. Xác minh 2 bước có được thực thi (Chỉ đọc)
archived

boolean

Cho biết liệu 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, tổ chức này được biểu thị dưới dạng dấu gạch chéo lên (/).
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 theo đị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
}
Trường
fullName

string

Họ và tên của người dùng được tạo bằng cách nối giá trị họ và tên.
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ự.

Phương thức

delete

 Xoá một 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 được phân trang của người dùng đã bị xoá hoặc tất cả người dùng trong một miền.

makeAdmin

 Đặt người dùng thành quản trị viên cấp cao.

patch

 Cập nhật người dùng bằng thông tin về bản vá ngữ nghĩa.

signOut

 Đăng xuất người dùng khỏi tất cả các phiên web và thiết bị rồ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 một người dùng.

watch

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