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

注意：删除用户的别名不会删除该用户。已删除的用户别名可以立即再次用作其他用户的别名。