Directory API: aliasy użytkownika

Utwórz alias użytkownika

Alias użytkownika to dodatkowy adres e-mail korzystający z tej samej skrzynki pocztowej co adres podstawowy adres e-mail. Alias użytkownika może być powiązany z inną domeną konta niż ta domena używana przez podstawowy adres e-mail użytkownika. W ciągu 24 godzin (często wcześniej) użytkownik zaczyna odbieranie wiadomości e-mail wysyłanych na ten adres. Interfejs API wymaga, aby parametr potwierdzenie własności domeny .

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

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

Żądanie JSON

Poniżej znajduje się żądanie JSON z przykładowym żądaniem utworzenia aliasu użytkownika. Użytkownik to liz@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ź zwróci właściwości nowego aliasu użytkownika.

Pobieranie wszystkich aliasów użytkownika

Aby pobrać wszystkie aliasy użytkownika we wszystkich domenach, użyj tego żądania GET i dołącz autoryzację opisaną w artykule Autoryzacja żądań. userKey może być podstawowym adresem e-mail użytkownika, id lub dowolnym z aliasów użytkownika e-maili. Informacje o właściwościach żą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 użytkownika 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. W opcji „Pobierz wszystkie aliasy” nie jest używany rozmiar strony, na przykład ciąg zapytania maxResults czy podział na strony. .

Odpowiedź JSON

Pomyślna odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź zawiera też aliasy użytkowników 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, wyślij żądanie DELETE i uwzględnij w nim autoryzacja opisana w Autoryzacja żądań. Może zająć do 24 godzin. userKey może być głównym adresem e-mail użytkownika, id lub dowolnym z tych adresów aliasy użytkownika e-maili. aliasId to alias” adresu e-mail Usunięto. Właściwości żądania i odpowiedzi znajdziesz w Dokumentacja API 

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
Na przykład to żądanie DELETE powoduje usunięcie aliasu chica@example.com dla klucza użytkownika 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.