Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Criar um alias de usuário
O alias de um usuário é um endereço de e-mail alternativo que usa a mesma caixa de entrada do
endereço de e-mail principal. Um alias de usuário pode ser associado a um domínio de conta diferente daquele
usado pelo endereço de e-mail principal do usuário. Em 24 horas (geralmente antes disso), o usuário começa
a receber os e-mails enviados para esse endereço. A API exige que a
propriedade do domínio seja confirmada
antes de criar o alias do usuário.
Para criar um alias de usuário, use a seguinte solicitação POST e inclua a autorização descrita em Autorizar solicitações. O userKey pode ser o endereço de e-mail principal do usuário, o id do usuário ou qualquer um dos e-mails de alias do usuário. Para as propriedades de solicitação e resposta, consulte a Referência da API:
POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
Solicitação JSON
A solicitação JSON a seguir mostra um exemplo de solicitação para criar o alias de um usuário. O usuário é liz@example.com e o alias é chica@example.com:
POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
O corpo da solicitação tem as novas informações de alias:
{"alias":"chica@example.com"}
Uma resposta bem-sucedida retorna um código de status HTTP 201. Além do código de status, a resposta retorna as propriedades do novo alias de usuário.
Extrair todos os aliases de um usuário
Para recuperar todos os aliases de um usuário em todos os domínios, use a solicitação GET abaixo e inclua a autorização descrita em Autorizar solicitações. O userKey pode ser o endereço de e-mail principal do usuário, o id do usuário ou qualquer um dos e-mails de alias do usuário. Para as propriedades de solicitação e resposta, consulte a Referência da API:
GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
Por exemplo, este URI de solicitação retorna todos os aliases para a chave de usuário liz@example.com:
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
Todos os aliases de usuário são retornados em ordem alfabética. Não há tamanho de página, como a string de consulta maxResults ou a paginação usada para a resposta "Recuperar todos os aliases".
Resposta JSON
Uma resposta bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta retorna os pseudônimos do usuário em ordem alfabética. Esses domínios de alias são o domínio principal e outros domínios na conta:
{"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" }]}
Excluir o alias de um usuário
Para excluir um alias de usuário, use a seguinte solicitação DELETE e inclua a
autorização descrita em
Autorizar solicitações. Pode levar até
24 horas para que o alias seja removido. O
userKey pode ser o endereço de e-mail principal do usuário, o id do usuário ou qualquer um
dos e-mails de alias do usuário. E aliasId é o endereço de e-mail do alias que está sendo
excluído. Para as propriedades de solicitação e resposta, consulte a
referência da API.
[null,null,["Última atualização 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."]]
