Get directory objects from a list of ids
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.
Note
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:
- Resolve IDs returned by functions (that return collections of IDs) such as getMemberObjects or getMemberGroups to their backing directory objects.
- Resolve ids persisted in an external store by the application to their backing directory objects.
Permissions
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.All |
Delegated (personal Microsoft account) | Not supported. |
Application | Directory.Read.All |
HTTP request
POST /directoryObjects/getByIds
Request headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer {token}. Required. |
Content-Type | string | application/json |
Request body
In the request body, provide a JSON object with the following parameters.
Parameter | Type | Description |
---|---|---|
ids | String collection | A collection of IDs for which to return objects. You can specify up to 1000 IDs. |
types | String collection | A collection of resource types that specifies the set of resource collections to search. If not specified, the default is directoryObject, which contains all of the resource types defined in the directory. Any object that derives from directoryObject may be specified in the collection; for example: user, group, device, and so on. To search for references to a Cloud Solution Provider partner organization specify directoryObjectPartnerReference. 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
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"
}
]
}
Feedback
Loading feedback...