Directory API：使用者別名

建立使用者別名

使用者的別名是備用電子郵件地址，使用者的主要電子郵件地址使用的信箱也適用於這項別名。使用者別名可與使用者主要電子郵件地址使用的網域以外的帳戶網域建立關聯。在 24 小時內 (通常會更快)，使用者就會開始收到傳送至這個地址的電子郵件。您必須先確認網域擁有權，才能使用 API 建立使用者別名。

注意：每位使用者的別名數量上限為 30 個。

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

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

JSON 要求

以下 JSON 要求示範建立使用者別名的示例要求。使用者為 [e-mail]，別名為 [e-mail]：

POST https://admin.googleapis.com/admin/directory/v1/users/[e-mail]/aliases

要求主體包含新的別名資訊：

{  
 "alias": "[e-mail]"
}

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

擷取使用者的所有別名

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

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

舉例來說，這個要求 URI 會傳回使用者鍵 [e-mail] 的所有別名：

GET https://admin.googleapis.com/admin/directory/v1/users/[e-mail]/aliases

系統會依照字母順序傳回所有使用者別名。系統不會提供頁面大小，例如用於「擷取所有別名」回應的 maxResults 查詢字串或分頁。

注意：這些是帳戶主網域或子網域中可編輯的使用者電子郵件別名。如要查看帳戶以外的使用者別名，請參閱使用者的 nonEditableAliases 屬性。

JSON 回應

成功的回應會傳回 HTTP 200 狀態碼。除了狀態碼外，回應還會依照字母順序傳回使用者的別名。這些別名網域是帳戶中的主網域和其他多個網域：

{
"kind": "directory#user#aliases",
"aliases": [
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[e-mail]",
  "alias": "[e-mail]"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[e-mail]",
  "alias": "[e-mail]"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[e-mail]",
  "alias": "[e-mail]"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[e-mail]",
  "alias": "[e-mail]"
 }
]
}

刪除使用者的別名

如要刪除使用者別名，請使用下列 DELETE 要求，並附上「授權要求」一節中所述的授權。系統最多可能需要 24 小時才會移除別名。userKey 可以是使用者的主要電子郵件地址、使用者 id，或任何使用者別名的電子郵件。aliasId 是您要刪除的別名電子郵件地址。如需要求和回應屬性的相關資訊，請參閱 API 參考資料。

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

舉例來說，這項 DELETE 要求會刪除使用者索引鍵 [e-mail] 的 [e-mail] 別名：

DELETE https://admin.googleapis.com/admin/directory/v1/users/[e-mail]/aliases/[e-mail]

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

注意：刪除使用者的別名不會刪除使用者。刪除的使用者別名可以立即用於其他使用者的別名。