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 la section Autoriser les requêtes. Les membres d'un groupe peuvent être des utilisateurs ou d'autres groupes. groupKey correspond à l'adresse e-mail du groupe du nouveau membre ou au 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. En outre, l'API renvoie une erreur pour les cycles d'appartenance à un groupe. Par exemple, si groupe1 est membre de groupe2, groupe2 ne peut pas être membre de groupe1.

Requête JSON

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

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

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

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

  • OWNER : ce rôle permet de modifier l'envoi de 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 membre OWNER doit être membre du groupe.
  • MANAGER : ce rôle n'est disponible que si Google Workspace est activé dans la console d'administration. Ce rôle permet d'effectuer toutes les opérations associées à un rôle PROPRIÉTAIRE, mais pas de désigner un membre comme PROPRIÉTAIRE ni de supprimer le groupe. Un groupe peut comporter plusieurs membres OWNER et MANAGER.
  • MEMBER : ce rôle permet de s'abonner à un groupe, de consulter les archives de discussions et de consulter la liste des membres du groupe. Pour plus d'informations sur les rôles des membres, consultez le Centre d'aide Administrateur.

Réponse JSON

Les réponses positives affichent un code d'état HTTP 200 ainsi que les informations d'adhésion du membre. id est l'identifiant unique d'adhésion du membre: 

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

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

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

Mettre à jour l'appartenance à un groupe

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

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 passe 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 GESTIONNAIRE, consultez le Centre d'aide Administrateur: 

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

Réponse JSON

Les réponses positives affichent un code d'état HTTP 200 ainsi que les informations d'appartenance mises à jour. id est l'identifiant unique d'adhésion du membre: 

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

Récupérer le membre d'un groupe

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

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

Réponse JSON

Les réponses positives affichent un code d'état HTTP 200 ainsi que les informations d'adhésion du membre. id est l'identifiant unique d'adhésion 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 du groupe

Pour récupérer tous les membres du groupe, utilisez la requête GET suivante et incluez l'autorisation décrite dans la section Autoriser les requêtes. groupKey est l'adresse e-mail du groupe ou l'adresse e-mail unique du groupe (id). 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 générées 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. Pour faciliter la lecture, cet exemple utilise des retours à la ligne: 

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 dans l'ordre alphabétique des' adresses e-mail. Utilisez également la chaîne de requête pageToken pour les réponses comportant un grand nombre de membres. Dans le cas d'une pagination, la réponse renvoie la propriété nextPageToken, qui contient un jeton pour la page de résultats suivante. Votre prochaine requête utilise ce jeton comme valeur de chaîne de requête pageToken.

Réponse JSON

Les réponses positives affichent un code d'état HTTP 200 et la liste d'informations sur les membres. id est l'identifiant d'adhésion unique du membre. Il existe un nextPageToken pour la liste de suivi 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": "GROUP"
   },
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "radhe@example.com",
    "role": "MANAGER",
    "type": "MEMBER"
   }
  ],
   "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 est le id unique du groupe, et memberKey est l'adresse e-mail principale de l'utilisateur ou du membre du groupe supprimé, ou le 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 groupKey est nnn et dont 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

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

Lorsqu'un membre est supprimé:

  • Les membres que vous retirez ne reçoivent plus les e-mails adressés au groupe.
  • Le fait de retirer un membre d'un groupe n'entraîne pas la suppression du compte utilisateur associé.
  • Si vous supprimez le propriétaire d'un groupe, celui-ci continue de fonctionner normalement. En tant qu'administrateur, vous pouvez gérer le groupe ou en transférer la propriété à un autre membre