Partager via


Répertorier les membres du groupe

Espace de noms: microsoft.graph

Obtenez la 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 rencontre un problème connu où les principaux de service ne sont pas répertoriés en tant que membres de groupe dans la version 1.0. Pour contourner ce problème, utilisez cette API sur le point de beta terminaison ou utilisez l’API /groups/{id}?$expand=members . Pour plus d’informations, consultez le problème connu associé.

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

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

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

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

Importante

Lorsqu’une application interroge une relation qui retourne une collection de types directoryObject , si elle n’a pas l’autorisation de lire un certain type de ressource, les membres de ce type sont retournés, mais avec des informations limitées. Par exemple, seule la propriété @odata.type pour le type d’objet et l’ID est retournée, tandis que les autres propriétés sont indiquées comme 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 de Répertoire.*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/members/read de rôle ou microsoft.directory/groups/members/limitedRead ou microsoft.directory/groups/hiddenMembers/read l’autorisation de rôle pour lire les membres masqués. Les rôles les moins privilégiés suivants sont pris en charge pour cette opération :

  • Propriétaires de groupe
  • Utilisateurs « Membres »
  • Utilisateurs « invités » : ont des autorisations de lecture limitées
  • Lecteurs d’annuaire
  • Rédacteurs d'annuaires
  • administrateur Groupes
  • Administrateur d’utilisateurs - Y compris les membres masqués
  • Administrateur Exchange - Y compris les membres masqués
  • Administrateur SharePoint - Y compris les 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’appartenances masqués, l’autorisation Member.Read.Hidden est également nécessaire.

Requête HTTP

GET /groups/{id}/members

Paramètres facultatifs de la requête

Cette méthode prend en charge les $filterparamètres de requête , $search$select$count, $top, , $search, et$expand OData pour personnaliser la réponse. Les tailles de page par défaut et maximales sont respectivement 100 et 999 objets de groupe. Certaines requêtes sont prises en charge uniquement lorsque vous utilisez l’en-tête ConsistencyLevel défini sur eventual et $count. Pour plus d’informations, consultez Fonctionnalités de requête avancées sur les objets d’annuaire.

Le cast OData est également activé. Par exemple, /groups/{id}}/members/microsoft.graph.user effectue une nouvelle tentative des membres du groupe qui sont des utilisateurs.

En-têtes de demande

En-tête Valeur
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
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 retourne cette erreur, car les groupes Microsoft 365 ne peuvent pas avoir d’autres groupes comme 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"
    }
  ]
}