Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Nutzeralias erstellen
Der Alias eines Nutzers ist eine alternative E-Mail-Adresse, die dasselbe Postfach verwendet wie die primäre E-Mail-Adresse des Nutzers. Ein Nutzeralias kann mit einer anderen Kontodomain verknüpft sein als der Domain, die für die primäre E-Mail-Adresse des Nutzers verwendet wird. E-Mails werden innerhalb von 24 Stunden (oft auch schon früher) an die neu eingerichtete Adresse zugestellt. Die API erfordert, dass die Inhaberschaft der Domain bestätigt wird, bevor Sie den Nutzeralias erstellen können.
Wenn Sie einen Nutzeralias erstellen möchten, verwenden Sie die folgende POST-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. userKey kann die primäre E-Mail-Adresse des Nutzers, die E-Mail-Adresse des Nutzers id oder eine der E-Mail-Adressen der Nutzeraliasse sein. Informationen zu den Anfrage- und Antworteigenschaften finden Sie in der API-Referenz:
POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
JSON-Anfrage
Die folgende JSON-Anfrage ist ein Beispiel für eine Anfrage zum Erstellen des Alias eines Nutzers. Der Nutzer ist liz@beispiel.de und der Alias ist chica@beispiel.de:
POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
Der Anfragetext enthält die neuen Aliasinformationen:
{"alias":"chica@example.com"}
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201 zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Eigenschaften für den neuen Nutzeralias zurückgegeben.
Alle Aliasse eines Nutzers abrufen
Wenn Sie alle Aliase eines Nutzers in allen Domains abrufen möchten, verwenden Sie die folgende GET-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. userKey kann die primäre E-Mail-Adresse des Nutzers, die E-Mail-Adresse des Nutzers id oder eine der E-Mail-Adressen der Nutzeraliasse sein. Informationen zu den Anfrage- und Antworteigenschaften finden Sie in der API-Referenz:
GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
Mit diesem Anfrage-URI werden beispielsweise alle Aliasse für den Nutzerschlüssel liz@beispiel.de zurückgegeben:
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
Alle Nutzeraliasse werden in alphabetischer Reihenfolge zurückgegeben. Es gibt keine Seitengröße wie den maxResults-Suchstring oder die Paginierung, die für die Antwort „Alle Aliase abrufen“ verwendet wird.
JSON-Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Aliasse des Nutzers in alphabetischer Reihenfolge zurückgegeben. Diese Aliasdomains sind die primäre Domain und andere Domains im Konto:
{"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" }]}
Alias eines Nutzers löschen
Wenn Sie einen Nutzeralias löschen möchten, verwenden Sie die folgende DELETE-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. Es kann bis zu 24 Stunden dauern, bevor die Änderung wirksam wird. userKey kann die primäre E-Mail-Adresse des Nutzers, der Nutzer id oder eine der E-Mail-Adressen der Nutzeraliasse sein. aliasId ist die E-Mail-Adresse des Alias, der gelöscht wird. Informationen zu den Anfrage- und Antworteigenschaften finden Sie in der API-Referenz.
[null,null,["Zuletzt aktualisiert: 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."]]
