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

成功的响应会返回 HTTP 200 状态代码