directoryObject: getByIdsdirectoryObject: getByIds

Namespace: microsoft.graphNamespace: microsoft.graph

Gibt die in einer Liste von IDs angegebenen Verzeichnisobjekte zurück.Return the directory objects specified in a list of IDs.

Hinweis

Diese API hat ein bekanntes Problem.This API has a known issue. Nicht alle zurückgegebenen Directory-Objekte sind die vollständigen Objekte mit all ihren Eigenschaften.Not all directory objects returned are the full objects containing all their properties.

Nachfolgend sind einige gängige Verwendungsmöglichkeiten für diese Funktion aufgeführt:Some common uses for this function are to:

  • Auflösen von IDs, die von Funktionen zurückgegeben werden (die Sammlungen von IDs zurückgeben), z. B. getMemberObjects oder getMemberGroups in ihre zugrunde liegenden Directory-Objekte.Resolve IDs returned by functions (that return collections of IDs) such as getMemberObjects or getMemberGroups to their backing directory objects.
  • Auflösen von durch die Anwendung permanent in einem externen Speicher gespeicherten IDs in ihre zugrunde liegenden Verzeichnisobjekte.Resolve IDs persisted in an external store by the application to their backing directory 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) Directory.Read.All, Directory.AccessAsUser.AllDirectory.Read.All, Directory.AccessAsUser.All
Delegiert (persönliches Microsoft-Konto)Delegated (personal Microsoft account) Nicht unterstütztNot supported.
AnwendungApplication Directory.Read.AllDirectory.Read.All

Wenn eine Anwendung eine Beziehung abfragt, die eine directoryobject-Typsammlung zurückgibt, wenn Sie nicht über die Berechtigung zum Lesen eines bestimmten abgeleiteten Typs (wie Gerät) verfügt, werden Member dieses Typs zurückgegeben, jedoch mit begrenzten Informationen.When an application queries a relationship that returns a directoryObject type collection, if it does not have permission to read a certain derived type (like device), members of that type are returned but with limited information. Mit diesem Verhalten können Anwendungen die am wenigsten privilegierten Berechtigungen anfordern, die Sie benötigen, anstatt sich auf die Berechtigungen "Directory. *" zu verlassen.With this behaviour applications can request the least privileged permissions they need, rather than rely on the set of Directory.* permissions. Ausführliche Informationen finden Sie unter Limited Information returned for unaccessible Member Objects.For details, see Limited information returned for inaccessible member objects.

HTTP-AnforderungHTTP request

POST /directoryObjects/getByIds

AnforderungsheaderRequest headers

NameName TypType BeschreibungDescription
AuthorizationAuthorization stringstring Bearer {token}. Erforderlich.Bearer {token}. Required.
Content-typeContent-type stringstring application/json. Erforderlich. application/json. Required.

AnforderungstextRequest body

Geben Sie im Anforderungstext ein JSON-Objekt mit den folgenden Parametern an.In the request body, provide a JSON object with the following parameters.

ParameterParameter TypType BeschreibungDescription
idsids String-SammlungString collection Eine Sammlung von IDs, für die Objekte zurückgegeben werden sollen.A collection of IDs for which to return objects. Die IDs sind GUIDs, die als Zeichenfolgen dargestellt werden.The IDs are GUIDs, represented as strings. Sie können bis zu 1000 IDs angeben.You can specify up to 1000 IDs.
typestypes String-SammlungString collection Eine Sammlung von Ressourcentypen, die den Satz von zu durchsuchenden Ressourcensammlungen angibt.A collection of resource types that specifies the set of resource collections to search. Wenn keine Angabe erfolgt, wird directoryObject als Standardwert verwendet; dieser enthält alle im Verzeichnis definierten Ressourcentypen.If not specified, the default is directoryObject, which contains all of the resource types defined in the directory. Jedes Objekt, das von directoryObject abgeleitet wird, kann in der Sammlung angegeben werden; Beispiel: user, group, device usw.Any object that derives from directoryObject may be specified in the collection; for example: user, group, device, and so on. Um nach Referenzen für ein Cloud Solution Provider-Partnerunternehmen zu suchen, geben Sie directoryObjectPartnerReference an.To search for references to a Cloud Solution Provider partner organization specify directoryObjectPartnerReference. Wenn keine Angabe erfolgt, wird directoryObject als Standardwert verwendet; dieser enthält alle im Verzeichnis definierten Ressourcentypen, außer bei Referenzen für ein Cloud Solution Provider-Partnerunternehmen.If not specified, the default is directoryObject, which contains all of the resource types defined in the directory, except for references to a Cloud Solution Provider partner organization. Bei den Werten wird nicht zwischen Groß- und Kleinschreibung unterschieden.The values are not case sensitive.

AntwortResponse

Wenn die Methode erfolgreich verläuft, werden ein 200 OK-Antwortcode und das Zeichenfolgensammlungsobjekt im Antworttext zurückgegeben.If successful, this method returns a 200 OK response code and a string collection object in the response body.

BeispielExample

AnforderungRequest

POST https://graph.microsoft.com/v1.0/directoryObjects/getByIds
Content-type: application/json

{
    "ids":["84b80893874940a3-97b7-68513b600544","5d6059b6368d-45f8-91e18e07d485f1d0"],
    "types":["user"]
}

AntwortResponse

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
    "value": [
      {
        "@odata.type": "#microsoft.graph.user",
        "id": "84b80893-8749-40a3-97b7-68513b600544",
        "accountEnabled": true,
        "displayName": "Trevor Jones"
      },
      {
        "@odata.type": "#microsoft.graph.user",
        "id": "84b80893-8749-40a3-97b7-68513b600544",
        "accountEnabled": true,
        "displayName": "Billy Smith"
      }
    ]
}