資源:User
Directory API 可讓您建立及管理帳戶的使用者、使用者別名和使用者的 Google 個人資料相片。如要進一步瞭解常見工作,請參閱《使用者帳戶開發人員指南》和《使用者別名開發人員指南》。
JSON 表示法 |
---|
{
"id": string,
"primaryEmail": string,
"password": value,
"hashFunction": string,
"isAdmin": boolean,
"isDelegatedAdmin": boolean,
"agreedToTerms": boolean,
"suspended": boolean,
"changePasswordAtNextLogin": boolean,
"ipWhitelisted": boolean,
"name": {
object ( |
欄位 | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
使用者的專屬 ID。使用者 |
||||||||||||||||||||||||||||||||||||||||||
primaryEmail |
使用者的主要電子郵件地址。建立此要求時,需要此屬性。 |
||||||||||||||||||||||||||||||||||||||||||
password |
儲存使用者帳戶的密碼。建立使用者帳戶時,必須提供密碼。您可以選擇是否在更新使用者時提供這項資訊;只有在使用者更新帳戶密碼時才需要提供這項資訊。系統一律不會在 API 的回應主體中傳回密碼值。 |
||||||||||||||||||||||||||||||||||||||||||
hashFunction |
儲存
如果指定的前置字元是前置字元的一部分,則長度不得超過 10,000。 |
||||||||||||||||||||||||||||||||||||||||||
isAdmin |
僅供輸出。表示具有超級管理員權限的使用者。您只能在「將使用者設為管理員」作業 ( makeAdmin 方法) 中編輯 |
||||||||||||||||||||||||||||||||||||||||||
isDelegatedAdmin |
僅供輸出。指出使用者是否是委派的管理員。 |
||||||||||||||||||||||||||||||||||||||||||
agreedToTerms |
僅供輸出。如果使用者已完成初始登入並接受《服務條款》協議,這個屬性就會是 |
||||||||||||||||||||||||||||||||||||||||||
suspended |
指出使用者是否遭到停權。 |
||||||||||||||||||||||||||||||||||||||||||
changePasswordAtNextLogin |
指出使用者是否強制在下次登入時變更密碼。使用者是透過第三方識別資訊提供者登入時,則不適用這項設定。 |
||||||||||||||||||||||||||||||||||||||||||
ipWhitelisted |
如果設為 |
||||||||||||||||||||||||||||||||||||||||||
name |
保留使用者的指定名稱和系列名稱,以及唯讀 |
||||||||||||||||||||||||||||||||||||||||||
kind |
僅供輸出。API 資源類型。以使用者資源來說,值為 |
||||||||||||||||||||||||||||||||||||||||||
etag |
僅供輸出。資源的 ETag。 |
||||||||||||||||||||||||||||||||||||||||||
emails |
使用者的電子郵件地址清單。系統允許的資料大小上限為 10 KB。
|
||||||||||||||||||||||||||||||||||||||||||
externalIds |
使用者的外部 ID 清單,例如員工 ID 或網路 ID。系統允許的資料大小上限為 2 KB。
|
||||||||||||||||||||||||||||||||||||||||||
relations |
使用者與其他使用者之間的關係清單。這個欄位允許的資料大小上限為 2KB。詳情請參閱管理使用者帳戶。
|
||||||||||||||||||||||||||||||||||||||||||
aliases[] |
僅供輸出。使用者的別名電子郵件地址清單。 |
||||||||||||||||||||||||||||||||||||||||||
isMailboxSetup |
僅供輸出。指出是否已建立使用者的 Google 信箱。此屬性僅適用於已獲派 Gmail 授權的使用者。 |
||||||||||||||||||||||||||||||||||||||||||
customerId |
僅供輸出。用於擷取所有帳戶使用者的客戶 ID。 |
||||||||||||||||||||||||||||||||||||||||||
addresses |
使用者地址清單。系統允許的資料大小上限為 10 KB。
|
||||||||||||||||||||||||||||||||||||||||||
organizations |
使用者所屬的機構清單。系統允許的資料大小上限為 10 KB。
|
||||||||||||||||||||||||||||||||||||||||||
lastLoginTime |
僅供輸出。使用者上次登入使用者帳戶的時間。這個值採 ISO 8601 日期和時間格式。時間則是 |
||||||||||||||||||||||||||||||||||||||||||
phones |
使用者電話號碼清單。系統允許的資料大小上限為 1 KB。
|
||||||||||||||||||||||||||||||||||||||||||
suspensionReason |
僅供輸出。在使用者帳戶或管理員停權時,將他們的帳戶停權。只有在 |
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoUrl |
僅供輸出。使用者個人資料相片的網址。這個網址可能是暫時或私人網址。 |
||||||||||||||||||||||||||||||||||||||||||
languages |
使用者語言清單。系統允許的資料大小上限為 1 KB。
|
||||||||||||||||||||||||||||||||||||||||||
posixAccounts |
使用者的 POSIX 帳戶資訊清單。
|
||||||||||||||||||||||||||||||||||||||||||
creationTime |
僅供輸出。使用者帳戶的建立時間。這個值採 ISO 8601 日期和時間格式。時間則是 |
||||||||||||||||||||||||||||||||||||||||||
nonEditableAliases[] |
僅供輸出。使用者無法編輯的別名電子郵件地址清單。網域通常位在帳戶的主網域或子網域之外。 |
||||||||||||||||||||||||||||||||||||||||||
sshPublicKeys |
安全殼層公開金鑰清單。
|
||||||||||||||||||||||||||||||||||||||||||
notes |
使用者為巢狀物件的附註。
|
||||||||||||||||||||||||||||||||||||||||||
websites |
使用者網站清單。
|
||||||||||||||||||||||||||||||||||||||||||
locations |
使用者所在地區清單。系統允許的資料大小上限為 10 KB。
|
||||||||||||||||||||||||||||||||||||||||||
includeInGlobalAddressList |
指出網域啟用聯絡人共用功能後,使用者的使用者個人資料是否會顯示在 Google Workspace 全域通訊清單中。如要進一步瞭解如何排除使用者個人資料,請參閱管理員說明中心。 |
||||||||||||||||||||||||||||||||||||||||||
keywords |
使用者關鍵字清單。系統允許的資料大小上限為 1 KB。
|
||||||||||||||||||||||||||||||||||||||||||
deletionTime |
僅供輸出。使用者帳戶遭到刪除的時間。這個值採 ISO 8601 日期和時間格式。時間則是 |
||||||||||||||||||||||||||||||||||||||||||
gender |
包含使用者性別的巢狀物件。這個欄位允許的資料大小上限為 1 KB。
|
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoEtag |
僅供輸出。使用者相片的 ETag (唯讀) |
||||||||||||||||||||||||||||||||||||||||||
ims |
使用者的即時 Messenger (IM) 帳戶。使用者帳戶可以有多個
|
||||||||||||||||||||||||||||||||||||||||||
customSchemas |
使用者的自訂欄位。索引鍵為
|
||||||||||||||||||||||||||||||||||||||||||
isEnrolledIn2Sv |
僅供輸出。已註冊兩步驟驗證 (唯讀) |
||||||||||||||||||||||||||||||||||||||||||
isEnforcedIn2Sv |
僅供輸出。是否強制執行兩步驟驗證 (唯讀) |
||||||||||||||||||||||||||||||||||||||||||
archived |
指出使用者是否已封存。 |
||||||||||||||||||||||||||||||||||||||||||
orgUnitPath |
與使用者相關聯的上層機構的完整路徑。如果上層機構為頂層機構,則以正斜線 ( |
||||||||||||||||||||||||||||||||||||||||||
recoveryEmail |
使用者的備援電子郵件地址。 |
||||||||||||||||||||||||||||||||||||||||||
recoveryPhone |
使用者的備援電話號碼。電話號碼必須採用 E.164 格式,開頭為加號 (+)。例如:+16506661212。 |
使用者名稱
JSON 表示法 |
---|
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string } |
欄位 | |
---|---|
fullName |
透過連結名字和姓氏值來建立使用者的全名。 |
familyName |
使用者的姓氏,建立使用者帳戶時必須提供。 |
givenName |
使用者的名字。建立使用者帳戶時必須提供。 |
displayName |
使用者的顯示名稱。上限:256 個字元。 |
方法 |
|
---|---|
|
刪除使用者。 |
|
擷取使用者。 |
|
建立使用者。 |
|
擷取已刪除使用者或網域中所有使用者的分頁清單。 |
|
將使用者設為超級管理員。 |
|
使用修補程式語意更新使用者。 |
|
將使用者登出所有網路和裝置工作階段,並重設登入 Cookie。 |
|
取消刪除已刪除的使用者。 |
|
更新使用者。 |
|
觀察使用者清單的變化。 |