API Directory: Alias utilisateur

Créer un alias utilisateur

L'alias d'un utilisateur est une adresse e-mail secondaire qui utilise la même boîte aux lettres 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 pour que vous puissiez créer l'alias utilisateur.

Pour créer un alias utilisateur, exécutez la requête POST suivante et incluez l'autorisation décrite dans Autoriser les requêtes. userKey peut être l'adresse e-mail principale de l'utilisateur, l'adresse e-mail de l'utilisateur id ou l'une des adresses e-mail des alias utilisateur. Pour 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 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. 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 dans tous les domaines, utilisez la requête GET suivante et incluez l'autorisation décrite dans Autoriser les requêtes. userKey peut être l'adresse e-mail principale de l'utilisateur, l'adresse e-mail de l'utilisateur id ou l'une des adresses e-mail des alias utilisateur. Pour 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 pour 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. Il n'existe pas de taille de page telle que la chaîne de requête maxResults ou la pagination 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. Avec le code d'état, la réponse renvoie les alias de l'utilisateur par ordre alphabétique. Ces 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 utilisateur, exécutez la requête DELETE suivante et incluez l'autorisation décrite dans 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 de l'utilisateur id ou l'une des adresses e-mail des alias utilisateur. aliasId correspond à l'adresse e-mail de l'alias en cours de suppression. 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.

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

Une réponse réussie renvoie un code d'état HTTP 200.