Benutzer auflistenList users

Dient zum Abrufen einer Liste von Benutzerobjekten.Retrieve a list of user objects.

BerechtigungenPermissions

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.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

BerechtigungstypPermission type Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)Permissions (from least to most privileged)
Delegiert (Geschäfts-, Schul- oder Unikonto)Delegated (work or school account) User.ReadBasic.All, User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.AllUser.ReadBasic.All, User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All
Delegiert (persönliches Microsoft-Konto)Delegated (personal Microsoft account) Nicht unterstütztNot supported.
AnwendungApplication User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.AllUser.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All

HTTP-AnforderungHTTP request

GET /users

Optionale AbfrageparameterOptional query parameters

Diese Methode unterstützt die OData-Abfrageparameter zur Anpassung der Antwort.This method supports the OData Query Parameters to help customize the response.

Standardmäßig wird nur ein begrenzter Satz von Eigenschaften zurückgegeben (businessPhones, displayName, givenName, id, jobTitle,mail, mobilePhone, officeLocation, preferredLanguage, surname, userPrincipalName).By default, only a limited set of properties are returned (businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, and userPrincipalName).

Um einen alternativen Eigenschaftensatz zurückzugeben, geben Sie den gewünschten Satz von user-Eigenschaften mithilfe des Odata-Abfrageparameters $select an.To return an alternative property set, specify the desired set of user properties using the OData $select query parameter. Um zum Beispiel displayName, givenName und postalCode zurückzugeben, fügen Sie Folgendes zur Abfrage hinzu: $select=displayName,givenName,postalCode.For example, to return displayName, givenName, and postalCode, add the following to your query $select=displayName,givenName,postalCode.

Hinweis: Bestimmte Eigenschaften können innerhalb einer Benutzersammlung nicht zurückgegeben werden. Die folgenden Eigenschaften werden nur unterstützt, wenn ein einzelner Benutzer abgerufen wird: aboutMe, birthday, hireDate,interests, mySite, pastProjects, preferredName, responsibilities, schools, skills, mailboxSettings.Certain properties cannot be returned within a user collection. The following properties are only supported when retrieving an single user: aboutMe, birthday, hireDate, interests, mySite, pastProjects, preferredName, responsibilities, schools, skills, mailboxSettings.

AnforderungsheaderRequest headers

KopfzeileHeader WertValue
AuthorizationAuthorization Bearer {token} (erforderlich)Bearer {token} (required)

AnforderungstextRequest body

Geben Sie für diese Methode keinen Anforderungstext an.Do not supply a request body for this method.

AntwortResponse

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK und eine Sammlung von user-Objekten im Antworttext zurückgegeben.If successful, this method returns a 200 OK response code and collection of user objects in the response body. Wenn eine umfangreiche Benutzerauflistung zurückgegeben wird, können Sie das Paging in Ihrer App verwenden.If a large user collection is returned, you can use paging in your app.

BeispieleExamples

Beispiel 1: Standard-BenutzeranforderungExample 1: Standard users request

Standardmäßig wird nur ein begrenzter Satz von Eigenschaften zurückgegeben (businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, userPrincipalName).By default, only a limited set of properties are returned (businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, userPrincipalName). Dieses Beispiel zeigt die standardmäßige Anforderung und Antwort.This example illustrates the default request and response.

AnforderungRequest
GET https://graph.microsoft.com/v1.0/users
AntwortResponse
HTTP/1.1 200 OK
Content-type: application/json
Content-length: 608

{
  "value": [
    {
      "businessPhones": [
        "businessPhones-value"
      ],
      "displayName": "displayName-value",
      "givenName": "givenName-value",
      "jobTitle": "jobTitle-value",
      "mail": "mail-value",
      "mobilePhone": "mobilePhone-value",
      "officeLocation": "officeLocation-value",
      "preferredLanguage": "preferredLanguage-value",
      "surname": "surname-value",
      "userPrincipalName": "userPrincipalName-value",
      "id": "id-value"
    }
  ]
}

Beispiel 2: Benutzeranforderung mit $selectExample 2: Users request using $select

Wenn Sie einen anderen Eigenschaftensatz benötigen, können Sie den OData-Abfrageparameter $select verwenden.If you need a different property set, you can use the OData $select query parameter. Um zum Beispiel displayName, givenName und postalCode zurückzugeben, fügen Sie Folgendes zur Abfrage hinzu: $select=displayName,givenName,postalCode.For example, to return displayName, givenName, and postalCode, you would use the add the following to your query $select=displayName,givenName,postalCode.

AnforderungRequest
GET https://graph.microsoft.com/v1.0/users?$select=displayName,givenName,postalCode
AntwortResponse

Hinweis: Das hier gezeigte Antwortobjekt ist möglicherweise aus Platzgründen abgeschnitten.Note: The response object shown here may be truncated for brevity.

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

{
  "value": [
    {
      "displayName": "displayName-value",
      "givenName": "givenName-value",
      "postalCode": "postalCode-value"
    }
  ]
}

Beispiel 3: Suchen eines Benutzerkontos mithilfe eines AnmeldenamensExample 2: Find a user account using a sign-in name

Suchen Sie ein Benutzerkonto in einem B2C-Mandanten unter Verwendung eines Anmeldenamens (auch bekannt als lokales Konto).Find a user account in a B2C tenant, using a sign-in name (also known as a local account). Diese Anforderung kann von einem Helpdesk dazu verwendet werden, das Benutzerkonto eines Kunden in einem B2C-Mandanten zu finden (in diesem Beispiel ist der B2C-Mandant "contoso.onmicrosoft.com").This request can be used by a helpdesk to find a customer's user account, in a B2C tenant (in this example the B2C tenant is contoso.onmicrosoft.com).

Hinweis

Beim Filtern nach identities müssen Sie issuer und issuerAssignedId angeben.When filtering on identities, you must supply both issuer and issuerAssignedId.

AnforderungRequest

Nachfolgend sehen Sie ein Beispiel der Anforderung.The following is an example of the request.

GET https://graph.microsoft.com/v1.0/users?$select=displayName,id&$filter=identities/any(c:c/issuerAssignedId eq 'j.smith@yahoo.com' and c/issuer eq 'contoso.onmicrosoft.com')

AntwortResponse

Nachfolgend sehen Sie ein Beispiel der Antwort.The following is an example of the response.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden. Ein tatsächlicher Aufruf gibt alle Eigenschaften zurück.Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.

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

{
  "value": [
    {
      "displayName": "John Smith",
      "id": "4c7be08b-361f-41a8-b1ef-1712f7a3dfb2"
    }
  ]
}