Répertorier les membres du groupe

Espace de noms: microsoft.graph

Obtenez une liste des membres directs du groupe . Un groupe peut avoir comme membres des utilisateurs, des contacts d’organisation et d’autres groupes. Cette opération n’est pas transitive.

Importante

Cette API présente un problème connu où les principaux de service ne sont pas répertoriés en tant que membres du groupe dans la version v1.0. Comme solution de contournement, utilisez cette API sur le point de beta terminaison ou utilisez-la /groups/{id}?$expand=members . Pour plus d’informations, voir le problème connu associé.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) GroupMember.ReadBasic.All Directory.Read.All, Group.Read.All, Group.ReadBasic.All, Group.ReadWrite.All, GroupMember.Read.All, GroupMember.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application GroupMember.ReadBasic.All Directory.Read.All, Group.Read.All, Group.ReadBasic.All, Group.ReadWrite.All, GroupMember.Read.All, GroupMember.ReadWrite.All

Importante

Lorsqu’une application interroge une relation qui renvoie une collection de type directoryObject , si elle n’est pas autorisée à lire un certain type de ressource, les membres de ce type sont renvoyés, mais avec des informations limitées. Par exemple, seule la propriété @odata.type pour le type d’objet et l’id est renvoyée, tandis que les autres propriétés sont indiquées sous la forme null. Avec ce comportement, les applications peuvent demander les autorisations les moins privilégiées dont elles ont besoin, plutôt que de s’appuyer sur l’ensemble des Directory.* autorisations. Pour plus d’informations, consultez Informations limitées retournées pour les objets membres inaccessibles.

Dans les scénarios délégués, l’utilisateur connecté doit également se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec l’autorisation microsoft.directory/groups/hiddenMembers/read de rôle ou microsoft.directory/groups/members/limitedRead ou l’autorisation de rôle pour lire les microsoft.directory/groups/members/read membres masqués. Les rôles les moins privilégiés suivants sont pris en charge pour cette opération :

  • Propriétaires du groupe
  • Utilisateurs « membres »
  • Les utilisateurs « invités » ont des autorisations de lecture limitées
  • Lecteurs d’annuaires
  • Rédacteurs d'annuaires
  • Administrateur de groupes
  • Administrateur d’utilisateur - Y compris les membres masqués
  • Administrateur Exchange - Y compris les membres masqués
  • Administrateur SharePoint - Inclusion des membres masqués
  • Administrateur Intune - Y compris les membres masqués
  • Administrateur Teams - Y compris les membres masqués
  • Administrateur Yammer - Y compris les membres masqués

Pour répertorier les membres d’un groupe d’appartenance masqué, l’autorisation Member.Read.Hidden est également requise.

Requête HTTP

GET /groups/{id}/members

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de $filterrequête , , $select$count, $search$top, et$expand OData pour personnaliser la réponse.

  • Le cast OData est activé. Par exemple, /groups/{id}/members/microsoft.graph.user récupère les membres du groupe qui sont des utilisateurs.
  • $search est pris en charge sur les propriétés displayName et Description uniquement.
  • L’utilisation de paramètres de requête avec cette API, à l’exception $expandde , n’est prise en charge qu’avec les paramètres de requête avancés. $expand n’est pas pris en charge avec les paramètres de requête avancés. Pour plus d’informations, voir Fonctionnalités de requête avancées sur les objets d’annuaire.

La taille de page par défaut et maximale est respectivement de 100 et 999 objets de groupe.

En-têtes de demande

En-tête Valeur
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
ConsistencyLevel éventuellement. Cet en-tête et $count sont requis lorsque vous utilisez les paramètres de requête de $search, $filter, $orderbyou de OData cast. Il utilise un index qui n’est peut-être pas mis à jour avec les modifications récentes apportées à l’objet.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et une collection d’objets directoryObject dans le corps de la réponse.

Une tentative de filtrage par un cast OData qui représente un type de membre non pris en charge retourne une 400 Bad Request erreur avec le Request_UnsupportedQuery code. Par exemple, /groups/{id}}/members/microsoft.graph.group lorsque le groupe est un groupe Microsoft 365, il renvoie cette erreur, car les groupes Microsoft 365 ne peuvent pas avoir d’autres groupes en tant que membres.

Exemples

Exemple 1 : obtenir l’adhésion directe d’un groupe

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315/members

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
  "value": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "mail": "user1@contoso.com"
    }
  ]
}

Exemple 2 : obtenir seulement un nombre de membres

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315/members/$count
ConsistencyLevel: eventual

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 200 OK
Content-type: text/plain

893

Exemple 3 : utiliser un cast OData pour obtenir un nombre d’utilisateurs uniquement

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/groups/{id}/members/microsoft.graph.user/$count
ConsistencyLevel: eventual

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 200 OK
Content-type: text/plain

893

Exemple 4 : utiliser $searchand la conversion OData pour obtenir l’appartenance des utilisateurs à des groupes contenant des noms complets contenant les lettres « PR », y compris un nombre d’objets retournés

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/groups/{id}/members/microsoft.graph.user?$count=true&$orderby=displayName&$search="displayName:Pr"&$select=displayName,id
ConsistencyLevel: eventual

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users(displayName,id)",
  "@odata.count":7,
  "value":[
    {
      "displayName":"Joseph Price",
      "id":"11111111-2222-3333-4444-555555555555"
    },
    {
      "displayName":"Preston Morales",
      "id":"66666666-7777-8888-9999-000000000000"
    }
  ]
}

Exemple 5 : utiliser un $filter pour obtenir l’appartenance au groupe avec un nom complet qui commence par la lettre « A », avec un nombre d’objets retournés

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/groups/{id}/members?$count=true&$filter=startswith(displayName, 'a')
ConsistencyLevel: eventual

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
  "@odata.count":76,
  "value":[
    {
      "displayName":"AAD Contoso Users",
      "mail":"AADContoso_Users@contoso.com"
    }
  ]
}