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 (liz@example.com) 的 Chicagoa@example.com 別名:
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

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