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 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.
[null,null,["Ostatnia aktualizacja: 2025-08-29 UTC."],[],[],null,["# Directory API: User Aliases\n\nCreate a user alias\n-------------------\n\nA user's alias is an alternate email address that uses the same mailbox used by the user's\nprimary email address. A user alias can be associated with a different account domain than that\ndomain used by the user's primary email address. Within 24 hours (often sooner), the user begins\nreceiving email sent to this address. The API requires that the\n[domain's ownership is confirmed](https://support.google.com/a/bin/answer.py?lev=index&cbid=sm2s8vsdlrxw&answer=60216&src=cb)\nbefore you can create the user alias.\n| **Note:** The maximum number of aliases per user is 30.\n\nTo create a user alias, use the following `POST` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `userKey` can be the user's primary email address, the user `id`, or any of the user aliases' emails. For the request and response properties, see the [API Reference](/workspace/admin/directory/reference/rest/v1/users.aliases/insert): \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases\n```\n\n### JSON request\n\nThe following JSON request shows a sample request to create a user's alias. The user is liz@example.com and the alias is chica@example.com: \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases\n```\nThe request body has the new alias information: \n\n```transact-sql\n{ \n \"alias\": \"chica@example.com\"\n}\n```\n\nA successful response returns an [HTTP 201 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes). Along with the status code, the response returns the properties for the new user alias.\n\nRetrieve all of a user's aliases\n--------------------------------\n\nTo retrieve all of a user's aliases across all domains, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `userKey` can be the user's primary email address, the user `id`, or any of the user aliases' emails. For the request and response properties, see the [API Reference](/workspace/admin/directory/reference/rest/v1/users.aliases/list): \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases\n```\nFor example, this request URI returns all aliases for the userKey, liz@example.com: \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases\n```\n\nAll user aliases are returned in alphabetical order. There is no page size such as the `maxResults` query string or pagination used for the 'Retrieve all aliases' response.\n| **Note:** These are editable user email alias in the account's primary domain or subdomains. For user aliases outside of the account, see the [user's nonEditableAliases property](/workspace/admin/directory/v1/reference/users#nonEditableAliases).\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes). Along with the status code, the response returns the user's aliases in alphabetical order. These alias domains are the primary domain and other multiple domains in the account: \n\n```transact-sql\n{\n\"kind\": \"directory#user#aliases\",\n\"aliases\": [\n {\n \"kind\": \"directory#user#alias\",\n \"id\": \"the unique user id\",\n \"primary_email\": \"liz@example.com\",\n \"alias\": \"chica@example.com\"\n },\n {\n \"kind\": \"directory#user#alias\",\n \"id\": \"the unique user id\",\n \"primary_email\": \"liz@example.com\",\n \"alias\": \"support@example.com\"\n },\n {\n \"kind\": \"directory#user#alias\",\n \"id\": \"the unique user id\",\n \"primary_email\": \"liz@example.com\",\n \"alias\": \"help@hr.example.com\"\n },\n {\n \"kind\": \"directory#user#alias\",\n \"id\": \"the unique user id\",\n \"primary_email\": \"liz@example.com\",\n \"alias\": \"tickets@jumboinc.com\"\n }\n]\n}\n```\n\nDelete a user's alias\n---------------------\n\nTo delete a user alias, use the following `DELETE` request and include the\nauthorization described in\n[Authorize requests](/workspace/admin/directory/v1/guides/authorizing). It can take up\nto 24 hours for the alias to be removed. The\n`userKey` can be the user's primary email address, the user `id`, or any of\nthe user aliases' emails. And the `aliasId` is the alias' email address that is being\ndeleted. For the request and response properties, see the\n[API reference](/workspace/admin/directory/reference/rest/v1/users.aliases/delete). \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId\n```\nFor example, this `DELETE` request deletes the chica@example.com alias for the userKey, liz@example.com: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com\n```\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes).\n| **Note:** Deleting a user's alias, does not delete the user. A deleted user alias can be used again as another user's alias immediately."]]
