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 для пользовательского ключа liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

В случае успешного ответа возвращается код состояния HTTP 200 .