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ơ của người dùng trên Google trong tài khoản của mình. Để biết thêm thông tin về các thao tác 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 của người dùng. Bạn có thể sử dụng id của người 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 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. 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 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 hàm băm của thuộc tính password. Các giá trị hashFunction sau đây được cho 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á thập lục phân đơn giản.
  • crypt – Tuân thủ thư viện mật mã C. Hỗ trợ các thuật toán băm DES, MD5 (phần tiền tố băm $1$), SHA-256 (phần tiền tố băm $5$) và SHA-512 (phần tiền tố băm $6$).

Nếu được chỉ định trong tiền tố, số 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 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 Đặ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 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 liệu 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 huỷ xoá 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 cho 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 quy trình đă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ị buộc 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 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)

Chứa tên và họ của người dùng, cũng như giá trị fullName chỉ có thể đọc. Số ký tự tối đa trong givenName và trong các giá trị familyName là 60. Ngoài ra, 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), 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 dành cho quản trị viên. 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à 10KB.

Trường

emails[].address

string

Địa chỉ email của người dùng. Cũng đó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. Bạn chỉ có thể đánh dấu một mục nhập là chính.

emails[].type

string

Loại tài khoản email. 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.
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 dạng 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à phải được đặ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ệ của người dùng với 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 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, thì 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 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 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 liệu hộp thư của người dùng trên Google đã được tạo hay chưa. Thuộc tính này chỉ áp dụng nếu người dùng đã được chỉ định 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 đã 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 được 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à 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. Trường 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ã ZIP/mã bưu chính, 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ã bưu chính hoặc mã zip, 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. Đị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òng mới là 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 mà người dùng thuộc về. Kích thước dữ liệu tối đa được phép là 10 KB.

Trường

organizations[].costCenter

string

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

organizations[].customType

string

Nếu giá trị của type 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 mà tổ chức thuộc về.

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 liệu đâ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

Ký hiệu chuỗi văn bản của tổ chức. Ví dụ: ký hiệu 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 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ị ở đị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 là số điện thoại chính của người dùng. Một 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ì customType cũng phải được đặt.

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 được. Số điện thoại có thể ở bất kỳ định dạng 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 của ảnh hồ sơ của 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 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 bạn đặt giá trị này, bạn sẽ không thể đặt languageCode.

languages[].languageCode

string

Biểu thị ngôn ngữ bằng chuỗi ISO 639. Hãy xem phần Mã ngôn ngữ để biết danh sách 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. Giá trị không hợp lệ gây ra SchemaException. Nếu bạn đặ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 bạn đặt customLanguage, thì bạn không thể đặt thuộc tính 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 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 vỏ đăng nhập cho tài khoản này.

posixAccounts[].systemId

string

Giá trị nhận dạng hệ thống cho tài khoản mà Tên người dùng hoặc Uid á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 gian tạ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.
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. Những miền này thường nằm ngoài miền chính hoặc miền con 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

Vân tay số 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 lồng nhau.

Trường

notes.contentType

string

Loại nội dung của ghi chú, văn bản thuần tuý hoặc HTML. Giá trị 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 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 sẽ chứa giá trị tuỳ chỉnh và bạn phải đặt thuộc tính này.

websites[].primary

boolean

Nếu là true, đâ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 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 được phép là 10 KB.

Trường

locations[].area

string

Vị trí văn bản. Thông tin 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 bản dựng.

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 từng vị trí bàn.

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 đặ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ơ của người dùng có xuất hiện trong danh sách địa chỉ toàn cầu 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 đượ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 sẽ 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ột mục nhập có thể có loại custom và có thể đặt tên bất kỳ cho mục nhập đó. Nếu đặ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ị ở đị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 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

Chuỗi ký tự mà con người đọc được, chứa cách gọi chủ sở hữu hồ sơ phù hợp, ví dụ: "anh/ông/tên" hoặc "họ/các bạn/tên".

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.

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 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 tài sản ims, nhưng chỉ một trong các tài sản ims này mới có thể là thông tin liên hệ chính qua tin nhắn nhanh.

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 type IM là custom, thì thuộc tính này chứa giá trị tuỳ 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 trong danh sách IM mới có thể có giá trị là true.

ims[].protocol

string

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

Giá trị được 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 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 Meetings
  • 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 nhanh. 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)

Các 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 lồng nhau.
  • 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ó thể đọc)
isEnforcedIn2Sv

boolean

Chỉ có đầu ra. Có thực thi tính năng xác minh 2 bước không (Chỉ có thể đọ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 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

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

Phương thức

delete

 Xoá người dùng.

get

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

insert

 Tạo người dùng.

list

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

makeAdmin

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

patch

 Cập nhật người dùng bằng cách sử dụng ngữ nghĩa bản 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

 Huỷ xoá người dùng đã 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.