Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Créer un alias utilisateur
L'alias d'un utilisateur est une adresse e-mail secondaire qui utilise la même boîte de réception que son adresse e-mail principale. Un alias utilisateur peut être associé à un domaine de compte différent de celui utilisé par l'adresse e-mail principale de l'utilisateur. L'utilisateur commence à recevoir les e-mails envoyés à cette adresse dans un délai de 24 heures (souvent plus tôt). L'API exige que la propriété du domaine soit confirmée avant que vous puissiez créer l'alias utilisateur.
Pour créer un alias utilisateur, utilisez la requête POST suivante et incluez l'autorisation décrite dans la section Autoriser les requêtes. userKey peut être l'adresse e-mail principale de l'utilisateur, l'id de l'utilisateur ou l'adresse e-mail de l'un des alias de l'utilisateur. Pour en savoir plus sur les propriétés de requête et de réponse, consultez la documentation de référence de l'API:
POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
Requête JSON
La requête JSON suivante montre un exemple de requête pour créer l'alias d'un utilisateur. L'utilisateur est liz@example.com et l'alias est chica@example.com:
POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
Le corps de la requête contient les informations sur le nouvel alias:
{"alias":"chica@example.com"}
Une réponse réussie renvoie un code d'état HTTP 201. En plus du code d'état, la réponse renvoie les propriétés du nouvel alias utilisateur.
Récupérer tous les alias d'un utilisateur
Pour récupérer tous les alias d'un utilisateur dans tous les domaines, utilisez la requête GET suivante et incluez l'autorisation décrite dans la section Autoriser les requêtes. userKey peut être l'adresse e-mail principale de l'utilisateur, son id ou l'adresse e-mail de l'un de ses alias. Pour en savoir plus sur les propriétés de requête et de réponse, consultez la documentation de référence de l'API:
GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
Par exemple, cet URI de requête renvoie tous les alias de la clé utilisateur liz@example.com:
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
Tous les alias utilisateur sont renvoyés par ordre alphabétique. Aucune taille de page, telle que la chaîne de requête maxResults ou la pagination, n'est utilisée pour la réponse "Récupérer tous les alias".
Réponse JSON
Une réponse réussie renvoie un code d'état HTTP 200. En plus du code d'état, la réponse renvoie les alias de l'utilisateur par ordre alphabétique. Ces domaines d'alias sont le domaine principal et les autres domaines du compte:
{"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" }]}
Supprimer l'alias d'un utilisateur
Pour supprimer un alias utilisateur, utilisez la requête DELETE suivante et incluez l'autorisation décrite dans la section Autoriser les requêtes. Un délai de 24 heures maximum est parfois nécessaire pour que la suppression de l'alias soit effective. userKey peut être l'adresse e-mail principale de l'utilisateur, l'id de l'utilisateur ou l'une des adresses e-mail des alias de l'utilisateur. aliasId est l'adresse e-mail de l'alias qui est supprimée. Pour en savoir plus sur les propriétés de requête et de réponse, consultez la documentation de référence de l'API.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/29 (UTC).
[null,null,["Dernière mise à jour le 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."]]
