Directory API: aliasy użytkownika

Tworzenie aliasu użytkownika

Alias użytkownika to dodatkowy adres e-mail w tej samej skrzynce pocztowej co główny adres e-mail użytkownika. Alias użytkownika może być powiązany z inną domeną konta niż domena używana przez podstawowy adres e-mail użytkownika. W ciągu 24 godzin (często szybciej) użytkownik zacznie otrzymywać e-maile wysyłane na ten adres. Interfejs API wymaga potwierdzenia własności domeny przed utworzeniem aliasu użytkownika.

Aby utworzyć alias użytkownika, użyj poniższego żądania POST i dołącz autoryzację opisaną w artykule Autoryzowanie żądań. userKey może być podstawowym adresem e-mail użytkownika, id lub dowolnym aliasem użytkownika. Właściwości żądania i odpowiedzi znajdziesz w dokumentacji interfejsu API:

POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases

Żądanie JSON

Poniższe żądanie JSON przedstawia przykładowe żądanie utworzenia aliasu użytkownika. Użytkownik to ela@example.com, a alias to chica@example.com:

POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
Treść żądania zawiera nowe informacje o aliasie:
{  
 "alias": "chica@example.com"
}

Pomyślna odpowiedź zwraca kod stanu HTTP 201. Wraz z kodem stanu odpowiedź zwraca też właściwości nowego aliasu użytkownika.

Pobierz wszystkie aliasy użytkownika

Aby pobrać wszystkie aliasy użytkownika ze wszystkich domen, użyj poniższego żądania GET i dołącz autoryzację opisaną w artykule Autoryzacja żądań. userKey może być podstawowym adresem e-mail użytkownika, id lub dowolnym aliasem użytkownika. Właściwości żądania i odpowiedzi znajdziesz w dokumentacji interfejsu API:

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
Na przykład ten identyfikator URI żądania zwraca wszystkie aliasy klucza userKey liz@example.com:
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

Wszystkie aliasy użytkowników są zwracane w kolejności alfabetycznej. Nie ma rozmiaru strony, np. ciągu zapytania maxResults lub podziału na strony dla odpowiedzi „Pobierz wszystkie aliasy”.

Odpowiedź JSON

Pomyślna odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź zawiera też aliasy użytkownika w kolejności alfabetycznej. Te aliasy domen to domena podstawowa i inne domeny na koncie:

{
"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"
 }
]
}

Usuwanie aliasu użytkownika

Aby usunąć alias użytkownika, użyj poniższego żądania DELETE i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. Usunięcie aliasu może potrwać do 24 godzin. userKey może być podstawowym adresem e-mail użytkownika, id lub dowolnym aliasem użytkownika. aliasId to adres e-mail aliasu, który jest usuwany. Właściwości żądania i odpowiedzi znajdziesz w dokumentacji interfejsu API.

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
Na przykład żądanie DELETE usuwa alias chica@example.com dla klucza userKey, liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Pomyślna odpowiedź zwraca kod stanu HTTP 200.