API Directory: membres du groupe

Ajouter un membre à un groupe

Pour ajouter un membre à un groupe, utilisez la requête POST suivante et incluez l'autorisation décrite dans Autoriser les requêtes. Un membre d'un groupe peut être un utilisateur ou un autre groupe. groupKey correspond à l'adresse e-mail du groupe du nouveau membre ou à l'id unique du groupe. 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/groups/groupKey/members

Si vous ajoutez un groupe en tant que membre d'un autre groupe, il peut s'écouler jusqu'à 10 minutes avant que les membres du sous-groupe n'apparaissent comme membres du groupe parent. De plus, l'API renvoie une erreur pour les cycles dans les appartenances aux groupes. Par exemple, si le groupe 1 est membre du groupe 2, le groupe 2 ne peut pas être membre du groupe 1.

Requête JSON

La requête JSON suivante montre un exemple de corps de requête qui crée un membre de groupe. L'adresse e-mail du membre est liz@example.com et son rôle dans le groupe est MEMBER. La requête POST utilise NNNNN pour groupKey : 

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members

{
   "email": "liz@example.com",
    "role": "MEMBER"
}

Le role d'un membre du groupe peut être :

  • OWNER : ce rôle permet d'envoyer des messages au groupe, d'ajouter ou de supprimer des membres, de modifier les rôles des membres, de modifier les paramètres du groupe et de supprimer le groupe. Un OWNER doit être membre du groupe.
  • MANAGER : ce rôle n'est disponible que si Google Workspace est activé à l'aide de la console d'administration Google. Un rôle de GESTIONNAIRE permet d'effectuer toutes les actions d'un rôle de PROPRIÉTAIRE, sauf de désigner un membre comme PROPRIÉTAIRE ou de supprimer le groupe. Un groupe peut comporter plusieurs membres ayant le rôle de PROPRIÉTAIRE et de GESTIONNAIRE.
  • MEMBER : ce rôle peut s'abonner à un groupe, consulter les archives de discussions et afficher la liste des membres du groupe. Pour en savoir plus sur les rôles des membres, consultez le centre d'aide pour les administrateurs.

Réponse JSON

Une réponse réussie renvoie un code d'état HTTP 200 et les informations sur l'abonnement du membre. id est l'identifiant unique du membre : 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MEMBER",
   "type": "GROUP"
  }

Le type d'un membre du groupe peut être :

  • GROUP : le membre est un autre groupe.
  • MEMBER : le membre est un utilisateur.

Modifier l'appartenance à un groupe

Pour mettre à jour une appartenance à un groupe, utilisez la requête PUT suivante et incluez l'autorisation décrite dans Autoriser les requêtes. groupKey correspond à l'adresse e-mail du groupe ou à son id unique, et memberKey correspond à l'adresse e-mail principale de l'utilisateur ou du groupe, à l'adresse e-mail d'alias d'un utilisateur ou à son id unique. 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 : 

PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey

Requête JSON

La requête JSON suivante montre un exemple de corps de requête qui met à jour les paramètres d'appartenance à un groupe. L'adresse e-mail du membre est liz@example.com et son rôle dans le groupe est modifié de MEMBER à MANAGER. Dans cet exemple, le groupKey de la requête PUT est NNNNN. Pour en savoir plus sur les rôles MEMBRE, PROPRIÉTAIRE et ADMINISTRATEUR, consultez le Centre d'aide sur l'administration : 

PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
 
{
   "email": "liz@example.com",
    "role": "MANAGER"
}

Réponse JSON

Une réponse réussie renvoie un code d'état HTTP 200 et les informations mises à jour sur l'abonnement. id est l'identifiant unique du membre : 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

Récupérer un membre d'un groupe

Pour récupérer une appartenance à un groupe, utilisez la requête GET suivante et incluez l'autorisation décrite dans Autoriser les requêtes. groupKey correspond à l'adresse e-mail du groupe ou à son id unique, et memberKey correspond à l'adresse e-mail principale de l'utilisateur ou du groupe, à l'adresse e-mail d'alias d'un utilisateur ou à son id unique. 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/groups/groupKey/members/memberKey

Réponse JSON

Une réponse réussie renvoie un code d'état HTTP 200 et les informations sur l'abonnement du membre. id est l'identifiant unique du membre : 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

Récupérer tous les membres d'un groupe

Pour récupérer tous les membres d'un groupe, utilisez la requête GET suivante et incluez l'autorisation décrite dans Autoriser les requêtes. groupKey correspond à l'adresse e-mail du groupe ou à son id unique. La chaîne de requête roles facultative est un filtre qui vous permet de récupérer les membres d'un groupe par rôle. Les collections de rôles obtenues sont dans l'ordre indiqué dans le filtre roles. 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. Des retours à la ligne ont été inclus dans cet exemple pour le rendre plus lisible. 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
?pageToken=pagination token
&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma
&maxResults=maximum results per response page

Tous les membres sont renvoyés par ordre alphabétique de leur adresse e-mail. Utilisez la chaîne de requête pageToken pour les réponses avec un grand nombre de membres. En cas de pagination, la réponse renvoie la propriété nextPageToken, qui contient un jeton pour la page suivante des résultats de la réponse. Votre prochaine requête utilise ce jeton comme valeur de chaîne de requête pageToken.

Réponse JSON

Une réponse réussie renvoie un code d'état HTTP 200 et la liste des informations sur les membres. id est l'identifiant unique du membre. Il existe un nextPageToken pour la liste des membres du groupe dans cette réponse : 

{
   "kind": "directory#members",
   "members": [
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "liz@example.com",
    "role": "MANAGER",
    "type": "USER"
   },
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "radhe@example.com",
    "role": "MANAGER",
    "type": "USER"
   }
  ],
   "nextPageToken": "NNNNN"
}

Supprimer l'appartenance à un groupe

Pour supprimer l'appartenance d'un membre à un groupe, utilisez la requête DELETE suivante et incluez l'autorisation décrite dans Autoriser les requêtes. groupKey correspond à l'id unique du groupe, et memberKey correspond à l'adresse e-mail principale du membre du groupe ou de l'utilisateur supprimé, ou à l'id unique 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 : 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
 Par exemple, cette requête DELETE supprime le membre dont le groupKey est nnn et dont le memberKey est l'adresse e-mail principale de l'utilisateur, liz@example.com : 
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com

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

Lorsqu'un membre est supprimé :

  • Les membres que vous supprimez ne reçoivent plus les e-mails adressés au groupe.
  • La suppression d'un membre d'un groupe ne supprime pas le compte de l'utilisateur.
  • Si vous supprimez le propriétaire d'un groupe, le groupe continue de fonctionner normalement. En tant qu'administrateur, vous pouvez gérer le groupe vous-même ou en transférer la propriété à un autre membre du groupe.