Directory API: aliasy użytkowników

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Tworzenie aliasu użytkownika

Alias użytkownika to dodatkowy adres e-mail, który jest używany przez podstawowy adres e-mail użytkownika. Alias użytkownika może być powiązany z inną domeną niż domena, 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. Zanim utworzysz alias użytkownika, interfejs API wymaga zweryfikowania własności domeny.

Aby utworzyć alias użytkownika, użyj poniższego żądania POST i dołącz autoryzację opisaną w sekcji Autoryzuj żądania. userKey może być podstawowym adresem e-mail użytkownika, id lub dowolnym z jego aliasów. Właściwość 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

Żą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 ma 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.

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 Autoryzowanie żądań. userKey może być podstawowym adresem e-mail użytkownika, id lub dowolnym z jego aliasów. Właściwość 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. W odpowiedzi „Pobierz wszystkie aliasy” nie ma rozmiaru strony, takiego jak ciąg zapytania lub podział na strony (maxResults).

Odpowiedź JSON

Pomyślna odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź zawiera aliasy użytkownika w kolejności alfabetycznej. Te aliasy to domena podstawowa i wiele innych domen 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 z jego aliasów. aliasId to adres e-mail aliasu, który jest usuwany. Właściwość właściwości żądania i odpowiedzi znajdziesz w dokumentacji API.

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
Na przykład żądanie DELETE spowoduje usunięcie aliasu 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.