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 状态代码