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 удаляет псевдоним chica@example.com для userKey, liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Успешный ответ возвращает код состояния HTTP 200 .