API Directory: alias utilisateur

Créer un alias d'utilisateur

Un alias d'utilisateur est une adresse e-mail secondaire qui utilise la même boîte aux lettres que l'adresse e-mail principale de l'utilisateur. Un alias d'utilisateur peut être associé à un domaine de compte différent de celui domaine utilisé par l'adresse e-mail principale de l'utilisateur. Dans les 24 heures (souvent plus tôt), l'utilisateur commence à recevoir les e-mails envoyés à cette adresse. L'API exige que la propriété du domaine soit confirmée avant que vous puissiez créer l'alias d'utilisateur. Les alias ne sont pas compatibles avec les utilisateurs invités.

Pour créer un alias d'utilisateur, utilisez la requête POST suivante et incluez l'autorisation décrite dans la section portant sur les requêtes d'autorisation. La userKey peut être l'adresse e-mail principale de l'utilisateur, son id ou l'une de ses adresses e-mail d'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 :

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 permettant de créer un alias d'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 du nouvel alias :

{  
 "alias": "chica@example.com"
}

Une réponse ayant abouti renvoie le code d'état HTTP 201. En plus du code d'état, la réponse renvoie les propriétés du nouvel alias d'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 portant sur les requêtes d'autorisation. La userKey peut être l'adresse e-mail principale de l'utilisateur, son id ou l'une de ses adresses e-mail d'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 l'userKey, liz@example.com :

GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

Tous les alias d'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 ayant abouti renvoie le 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 plusieurs 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 d'utilisateur, utilisez la requête DELETE suivante et incluez l' autorisation décrite dans Autoriser les requêtes. Un délai de 24 heures maximum est parfois nécessaire pour que la suppression de l'alias soit effective. Le userKey peut être l'adresse e-mail principale de l'utilisateur, son id ou l'une de ses adresses e-mail d'alias. L'aliasId est l'adresse e-mail de l'alias qui est supprimé. 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.

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId

Par exemple, cette requête DELETE supprime l'alias chica@example.com pour l'userKey, liz@example.com :

DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Une réponse ayant abouti renvoie le code d'état HTTP 200.