Directory API: aliasy użytkowników

Tworzenie aliasu użytkownika

Alias użytkownika to dodatkowy adres e-mail, który korzysta z tej samej skrzynki pocztowej co podstawowy 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. Aby można było utworzyć alias użytkownika, interfejs API wymaga potwierdzenia własności domeny.

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

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

Żądanie JSON

Poniższe żądanie JSON zawiera przykładowe żądanie 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 informacje o nowym adresie: 
{  
 "alias": "chica@example.com"
}

Pomyślna odpowiedź zwraca kod stanu HTTP 201. Oprócz kodu stanu odpowiedź zawiera też 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 dodaj autoryzację opisaną w sekcji Autoryzowanie żądań. userKey może być podstawowym adresem e-mail użytkownika, adresem użytkownika id lub dowolnym z adresów e-mail aliasów użytkownika. Właściwości żądań i odpowiedzi znajdziesz w dokumentacji 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 porządku alfabetycznym. W odpowiedzi „Pobierz wszystkie aliasy” nie ma rozmiaru strony, takiego jak ciąg zapytania maxResults, ani podziału na strony.

Odpowiedź JSON

Pomyślna odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź zawiera też pseudonimy użytkownika w kolejności alfabetycznej. Domeny aliasów 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 tego żądania DELETE i dołącz autoryzację opisaną w artykule Autoryzowanie żądań. Usunięcie aliasu może potrwać do 24 godzin. userKey może być podstawowym adresem e-mail użytkownika, adresem użytkownika id lub dowolnym z adresów e-mail aliasów użytkownika. aliasId to adres e-mail aliasu, który jest usuwany. Właściwości żądań i odpowiedzi znajdziesz w dokumentacji API. 

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
 Na przykład to żądanie DELETE usuwa alias 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.