API Directory: alias utilisateur

Créer un alias d'utilisateur

L'alias d'un utilisateur est une adresse e-mail secondaire qui utilise la même boîte aux lettres que la boîte aux lettres adresse e-mail principale. Un alias d'utilisateur peut être associé à un domaine de compte différent de celui-ci. 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 nécessite que la propriété du domaine est confirmée avant de pouvoir 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, l'utilisateur id ou tout alias de l'utilisateur e-mails. 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 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 nouvelles informations d'alias: 
{  
 "alias": "chica@example.com"
}

Les réponses positives affichent 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, l'utilisateur id ou tout alias de l'utilisateur e-mails. 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'utilisateurKey, 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 utilisée pour "Récupérer tous les alias" de réponse.

Réponse JSON

Les réponses positives affichent 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 domaines d'alias suivants sont le 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, utilisez la requête DELETE suivante et incluez les l'autorisation décrite dans Autoriser les requêtes Cela peut prendre à 24 heures, le temps que l’alias soit supprimé. La userKey peut être l'adresse e-mail principale de l'utilisateur, l'utilisateur id ou l'une des les alias d'utilisateur : e-mails. Et aliasId est l'alias l'adresse e-mail à laquelle supprimés. Pour les propriétés de requête et de réponse, consultez les 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 de l'utilisateurKey, liz@example.com: 
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Les réponses positives affichent un code d'état HTTP 200.