directoryObject: getByIdsdirectoryObject: getByIds

名前空間: microsoft.graphNamespace: microsoft.graph

ID のリストで指定されたディレクトリ オブジェクトを返します。Return the directory objects specified in a list of IDs.

注意

この API には既知の問題があります。This API has a known issue. 返されるすべてのディレクトリ オブジェクトが、すべてのプロパティを含む完全なオブジェクトであるとは限りません。Not all directory objects returned are the full objects containing all their properties.

この関数の一般的な用途は次のとおりです。Some common uses for this function are to:

  • getMemberObjects または getMemberGroups などの (ID のコレクションを返す) 関数から返された ID を、バッキング ディレクトリ オブジェクトに解決する。Resolve IDs returned by functions (that return collections of IDs) such as getMemberObjects or getMemberGroups to their backing directory objects.
  • アプリケーションによって外部記憶装置に保存されている ID をバッキング ディレクトリ オブジェクトに解決する。Resolve IDs persisted in an external store by the application to their backing directory objects.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Directory.Read.All、Directory.AccessAsUser.AllDirectory.Read.All, Directory.AccessAsUser.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication Directory.Read.AllDirectory.Read.All

アプリケーションが directoryObject 型のコレクションを返す関係をクエリするときに、特定の派生型 (デバイスなど) を読み取るアクセス許可がない場合、その型のメンバーが返されますが、情報は限られます。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. この動作により、アプリケーションは、Directory.* 権限が付与されたアクセス許可のセットに依存するのではなく、必要な最小限のアクセス許可を要求できます。With this behaviour applications can request the least privileged permissions they need, rather than rely on the set of Directory.* permissions. 詳細については、「アクセスできないメンバー オブジェクトについて、限定された情報が返される」を参照してください。For details, see Limited information returned for inaccessible member objects.

HTTP 要求HTTP request

POST /directoryObjects/getByIds

要求ヘッダーRequest headers

名前Name 種類Type 説明Description
AuthorizationAuthorization stringstring ベアラー {トークン}。必須。Bearer {token}. Required.
Content-typeContent-type stringstring application/json. Required.application/json. Required.

要求本文Request body

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。In the request body, provide a JSON object with the following parameters.

パラメーターParameter 種類Type 説明Description
idsids String collectionString collection オブジェクトを戻す ID のコレクション。A collection of IDs for which to return objects. ID は、文字列として表された GUID です。The IDs are GUIDs, represented as strings. 最大 1000 ID まで指定できます。You can specify up to 1000 IDs.
typestypes String コレクションString collection 検索する一連のリソース コレクションを指定するリソース型のコレクションです。A collection of resource types that specifies the set of resource collections to search. 指定しない場合、既定値は、ディレクトリで定義されているすべてのリソース型を含む directoryObject になります。If not specified, the default is directoryObject, which contains all of the resource types defined in the directory. directoryObject から派生する任意のオブジェクトをコレクションに指定できます。例: usergroupdevice など。Any object that derives from directoryObject may be specified in the collection; for example: user, group, device, and so on. クラウド ソリューション プロバイダー パートナー組織への参照を検索するには、directoryObjectPartnerReference を指定します。To search for references to a Cloud Solution Provider partner organization specify directoryObjectPartnerReference. 指定しない場合、既定値は、ディレクトリで定義されているすべてのリソース型を含む directoryObject になります (クラウド ソリューション プロバイダー パートナー組織への参照をのぞく)。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. 値では、大文字と小文字は区別されません。The values are not case sensitive.

応答Response

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で文字列コレクション オブジェクトを返します。If successful, this method returns a 200 OK response code and a string collection object in the response body.

Example

要求Request

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

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

応答Response

注: 読みやすくするために、ここに示す応答オブジェクトは短くされている場合があります。実際の呼び出しからは、すべてのプロパティが返されます。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"
      }
    ]
}