List group members

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Dient zum Abrufen einer Liste der direkten Mitglieder einer Gruppe. Eine Gruppe kann Benutzer, Kontakte, Geräte, Dienstprinzipale und andere Gruppen als Mitglieder haben. Dieser Vorgang ist nicht transitiv.

Wenn eine Gruppe mehr als 100 Mitglieder enthält, gibt Microsoft Graph eine @odata.nextLink-Eigenschaft in der Antwort zurück, die eine URL zur nächsten Ergebnisseite enthält. Wenn diese Eigenschaft vorhanden ist, stellen Sie als Nächstes zusätzliche Anforderungen mit der URL @odata.nextLink in jeder Antwort, bis alle Ergebnisse zurückgegeben werden, wie in Paging der Microsoft Graph-Daten in Ihrer App beschrieben.

Berechtigungen

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.

Berechtigungstyp Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto) GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt
Anwendung GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All

Hinweis: Um die Mitglieder einer ausgeblendeten Mitgliedschaftsgruppe auflisten zu können, ist die Berechtigung "Member.Read.Hidden" erforderlich.

Wenn eine Anwendung eine Beziehung abfragt, die eine Sammlung vom Typ directoryObject zurückgibt, werden, wenn sie keine Berechtigung zum Lesen eines bestimmten abgeleiteten Typs (z. B. Gerät) hat, Mitglieder dieses Typs zurückgegeben, jedoch mit begrenzten Informationen. Mit diesem Verhalten können Anwendungen die am wenigsten privilegierten Berechtigungen anfordern, die sie benötigen, anstatt auf die benannte Menge der *Directory.**-Berechtigungen zu vertrauen. Einzelheiten finden Sie unter Eingeschränkte Informationen, die für nicht zugängliche Mitgliedsobjekte zurückgegeben werden.

HTTP-Anforderung

GET /groups/{id}/members

Optionale Abfrageparameter

Diese Methode unterstützt die OData-Abfrageparameter zur Anpassung der Antwort, einschließlich $search, $count und $filter. OData-Cast ist ebenfalls aktiviert, z. B. können Sie einen Cast durchführen, um nur die Benutzer abzurufen, die Mitglieder der Gruppe sind. Sie können $search auf die Eigenschaft displayName verwenden. Wenn Elemente für diese Ressource hinzugefügt oder aktualisiert werden, werden sie speziell für die Verwendung mit den $count und $search Abfrageparametern indexiert. Es kann zu einer geringfügigen Verzögerung zwischen dem Hinzufügen oder Aktualisieren eines Elements und der Verfügbarkeit im Index kommen.

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich.
ConsistencyLevel schließlich. Diese Kopfzeile und $count sind bei Verwendung der Abfrageparameter $search, $filter, $orderby oder OData-Cast erforderlich. Es wird ein Index verwendet, der möglicherweise nicht auf dem neuesten Stand der jüngsten Änderungen am Objekt ist.

Anforderungstext

Geben Sie für diese Methode keinen Anforderungstext an.

Antwort

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK und eine Sammlung von directoryObject-Objekten im Antworttext zurückgegeben.

Beispiele

Beispiel 1: Abrufen der direkten Mitgliedschaft in einer Gruppe

Anforderung

Nachfolgend sehen Sie ein Beispiel der Anforderung.

GET https://graph.microsoft.com/beta/groups/{id}/members

Antwort

Nachfolgend sehen Sie ein Beispiel der Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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

{
  "value": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "mail": "group1@contoso.com",
      "mailEnabled": true,
      "mailNickname": "Contoso1",
      "securityEnabled": true
    }
  ]
}

Beispiel 2: Abrufen der Anzahl aller Mitgliedschaften

Anforderung

Nachfolgend sehen Sie ein Beispiel der Anforderung.

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

Antwort

Nachfolgend sehen Sie ein Beispiel der Antwort.

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

893

Beispiel 3: OData-Cast verwenden, um nur die Anzahl der Mitgliedschaften eines Benutzers abzurufen

Anforderung

Nachfolgend sehen Sie ein Beispiel der Anforderung.

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

Antwort

Nachfolgend sehen Sie ein Beispiel der Antwort.

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

893

Beispiel 4: Verwenden sie $search und OData-Umwandlung, um Benutzermitgliedschaften in Gruppen mit Anzeigenamen abzurufen, die die Buchstaben "Pr" enthalten, einschließlich der Anzahl der zurückgegebenen Objekte.

Anforderung

Nachfolgend sehen Sie ein Beispiel der Anforderung.

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

Antwort

Nachfolgend sehen Sie ein Beispiel der Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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

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

Beispiel 5: $filter verwenden, um Gruppenmitgliedschaften abzurufen, deren Anzeigename mit "A" beginnt, einschließlich einer Zählung der erhaltenen Objekte

Anforderung

Nachfolgend sehen Sie ein Beispiel der Anforderung.

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

Antwort

Nachfolgend sehen Sie ein Beispiel der Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#groups",
  "@odata.count":76,
  "value":[
    {
      "displayName":"AAD Contoso Users",
      "mail":"AADContoso_Users@contoso.com",
      "mailEnabled":true,
      "mailNickname":"AADContoso_Users",
      "securityEnabled":true
    }
  ]
}

Beispiel 6: Verwenden der OData-Umwandlung zum Abrufen von Dienstprinzipalen, die als Gruppenmitglieder hinzugefügt wurden

Anforderung

Nachfolgend sehen Sie ein Beispiel der Anforderung.

GET https://graph.microsoft.com/beta/groups/3802e9bb-0951-4e18-b9eb-f934b4241194/members/microsoft.graph.servicePrincipal

Antwort

Nachfolgend sehen Sie ein Beispiel der Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#servicePrincipals",
  "value": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "deletedDateTime": null,
      "accountEnabled": true,
      "appDisplayName": "Contoso Azure App",
      "appId": "11111111-2222-3333-4444-555555555555",
    }
  ]
}