Directory API：使用者別名

建立使用者別名

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

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

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

JSON 要求

下列 JSON 要求顯示建立使用者別名的要求範例。使用者為 liz@example.com，別名為 chica@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 (liz@example.com) 的別名 chica@example.com：

DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

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