Directory API:使用者別名

建立使用者別名

使用者的別名是指備用電子郵件地址,與使用者的信箱使用同一個信箱 。使用者別名可與其他帳戶網域建立關聯 使用者主要電子郵件地址所用的網域。使用者在 24 小時內 (通常是更快) 開始 。API 要求 網域的擁有權已確認 才能開始建立使用者別名

如要建立使用者別名,請使用下列 POST 要求,並加入「授權要求」中所述的授權。userKey 可以是使用者的主要電子郵件地址、id 或任何使用者別名電子郵件。如需要求和回應屬性,請參閱 API 參考資料

POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases

JSON 要求

下列 JSON 要求顯示了建立使用者別名的範例要求。假設使用者是 liz@example.com,別名為 Chicagoa@example.com:

POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
要求主體包含新的別名資訊:
{  
 "alias": "chica@example.com"
}

成功的回應會傳回 HTTP 201 狀態碼。除了狀態碼,回應也會傳回新使用者別名的屬性。

擷取使用者的所有別名

如要擷取使用者所有網域的所有別名,請使用下列 GET 要求,並加入「授權要求」中所述的授權。userKey 可以是使用者的主要電子郵件地址、id 或任何使用者別名電子郵件。如需要求和回應屬性,請參閱 API 參考資料

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
舉例來說,這個要求 URI 會傳回 userKey 的所有別名 liz@example.com:
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

所有使用者別名都會依字母順序傳回。沒有頁面大小,例如 maxResults 查詢字串或「擷取所有別名」的分頁回應。

JSON 回應

成功的回應會傳回 HTTP 200 狀態碼。除了狀態碼,回應也會依字母順序傳回使用者的別名。以下別名網域為主網域,以及帳戶中的其他多個網域:

{
"kind": "directory#user#aliases",
"aliases": [
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "chica@example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "support@example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "help@hr.example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "tickets@jumboinc.com"
 }
]
}

刪除使用者的別名

如要刪除使用者別名,請使用下列 DELETE 要求並加入 授權程序 授權要求。所需時間 並等待 24 小時移除別名 userKey 可以是使用者的主要電子郵件地址、id 或任何 使用者別名電子郵件。aliasId 是別名驗證電子郵件地址 已刪除。如需要求和回應屬性,請參閱 API 參考資料

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
舉例來說,這個 DELETE 要求會刪除 userKey 的 shia@example.com 別名 liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

成功的回應會傳回 HTTP 200 狀態碼