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ż ta, której używa 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, zanim będzie można utworzyć alias użytkownika. Aliasy nie są obsługiwane w przypadku użytkowników-gości.

Aby utworzyć alias użytkownika, użyj poniższego żądania POST i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. userKey może być podstawowym adresem e-mail użytkownika, id lub dowolnym adresem e-mail aliasu użytkownika. Informacje o właściwościach żądań i odpowiedzi znajdziesz w dokumentacji 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 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. Oprócz kodu stanu odpowiedź zwraca 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 sekcji Autoryzowanie żądań. userKey może być podstawowym adresem e-mail użytkownika, id lub dowolnym adresem e-mail aliasu użytkownika. Informacje o właściwościach żą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 dla 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 przypadku odpowiedzi „Pobierz wszystkie aliasy” nie ma rozmiaru strony, takiego jak ciąg zapytania maxResults czy podział na strony.

Odpowiedź JSON

Prawidłowa odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź zawiera też aliasy użytkownika w porządku alfabetycznym. Te domeny aliasowe 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, użytkownikiem id lub dowolnym adresem e-mail aliasu użytkownika. aliasId to adres e-mail aliasu, który jest usuwany. Informacje o właściwościach żądań i odpowiedzi znajdziesz w dokumentacji API.

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

Na przykład ta prośba 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

Prawidłowa odpowiedź zwraca kod stanu HTTP 200.