Directory API:用户别名

创建用户别名

用户的别名是指备用邮箱,其使用的邮箱与用户的主电子邮件地址相同。用户别名可以与用户的主电子邮件地址所使用的网域不同的账号网域。在 24 小时(通常更快)内,用户会开始接收发送到此地址的电子邮件。您必须先确认网域的所有权,然后才能创建用户别名。

要创建用户别名,请使用以下 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 状态代码