ID のリストからディレクトリ オブジェクトを取得します。Get directory objects from a list of ids

ID のリストで指定されたディレクトリ オブジェクトを返します。注:ここで返されるディレクトリ オブジェクトは、すべてのプロパティを含む完全なオブジェクトです。この操作に $select クエリ オプションは使用できません。Returns the directory objects specified in a list of ids. NOTE: The directory objects returned are the full objects containing all their properties. The $select query option is not available for this operation.

この関数の一般的な用途は次のとおりです。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

HTTP 要求HTTP request

POST /directoryObjects/getByIds

要求ヘッダーRequest headers

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

要求本文Request body

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

パラメーターParameter Type 説明Description
idsids String collectionString collection オブジェクトを戻す ID のコレクション。最大 1000 ID まで指定できます。A collection of ids for which to return objects. 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 200 OK response code and 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 may be truncated for brevity. All of 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"
      }
    ]
}