API Directory: alias utilisateur

Créer un alias d'utilisateur

L'alias d'un utilisateur est une adresse e-mail secondaire associée à la même boîte aux lettres que celle de son adresse e-mail principale. Un alias d'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 nécessite que la propriété du domaine soit confirmée pour que vous puissiez créer l'alias d'utilisateur.

Pour créer un alias d'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, id ou n'importe quelle adresse e-mail d'alias d'utilisateur. Pour en savoir plus sur les propriétés des requêtes et des réponses, 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 présente 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"
}

Les appels réussis renvoient un code d'état HTTP 201. Avec le 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 sur 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, id ou n'importe quelle adresse e-mail d'alias d'utilisateur. Pour en savoir plus sur les propriétés des requêtes et des réponses, consultez la documentation de référence de l'API: 

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
Par exemple, l'URI de cette requête renvoie tous les alias de la clé 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 dans l'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

Les appels réussis renvoient un code d'état HTTP 200. Avec le code d'état, la réponse renvoie les alias de l'utilisateur dans l'ordre alphabétique. Les alias de domaine suivants correspondent au domaine principal et à d'autres domaines multiples 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, exécutez la requête DELETE suivante et incluez l'autorisation décrite dans la section Autoriser les requêtes. La suppression de l'alias peut prendre jusqu'à 24 heures. userKey peut être l'adresse e-mail principale de l'utilisateur, l'adresse e-mail id ou l'une des adresses e-mail des alias d'utilisateur. Et aliasId est l'adresse e-mail de l'alias en cours de suppression. Pour les propriétés des requêtes et des réponses, consultez la documentation de référence de l'API. 

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
Par exemple, la requête DELETE supprime l'alias chica@example.com de la clé userKey, liz@example.com : 
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Les appels réussis renvoient un code d'état HTTP 200.