List memberOf
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Get groups and administrative units that the device is a direct member of. This operation is not transitive.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Device.Read.All | Directory.Read.All, Directory.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Device.Read.All | Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
Important
When an application queries a relationship that returns a directoryObject type collection, if it doesn't have permission to read a certain resource type, members of that type are returned but with limited information. For example, only the @odata.type property for the object type and the id is returned, while other properties are indicated as null
. With this behavior, 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.
Important
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.
- Directory Readers
- Global Reader
- Intune Administrator
- Windows 365 Administrator
HTTP request
You can address the device using either its id or deviceId.
GET /devices/{id}/memberOf
GET /devices(deviceId='{deviceId}')/memberOf
Optional query parameters
This method supports the $select
, $search
, $count
, and $filter
OData query parameters to help customize the response. OData cast is also enabled, for example, you can cast to get just the directoryRoles the device is a member of. You can use $search
on the displayName and description properties. The default and maximum page sizes are 100 and 999 objects respectively.
Some queries are supported only when you use the ConsistencyLevel header set to eventual
and $count
. For more information, see Advanced query capabilities on directory objects.
Request headers
Header | Value |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
ConsistencyLevel | eventual. This header and $count are required when using $search , OData cast parameters, or in specific usage of $filter . For more information about the use of ConsistencyLevel and $count , see Advanced query capabilities on directory objects. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and collection of directoryObject objects in the response body.
Examples
Example 1: Get groups that the device is a direct member of
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/devices/{id}/memberOf
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"@odata.type": "#microsoft.graph.group",
"id": "id-value",
"createdDateTime": null,
"description": "All users at the company",
"displayName": "All Users",
"groupTypes": [],
"mailEnabled": false,
"securityEnabled": true,
}
]
}
Example 2: Get only a count of all memberships
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/devices/{id}/memberOf/$count
ConsistencyLevel: eventual
Response
The following example shows the response.
HTTP/1.1 200 OK
Content-type: text/plain
394
Example 3: Use OData cast and $search to get membership with display names that contain the letters 'Video' including a count of returned objects
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/devices/{id}/memberOf/microsoft.graph.group?$count=true&$orderby=displayName&$search="displayName:Video"
ConsistencyLevel: eventual
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#directoryObjects",
"@odata.count":1396,
"value":[
{
"displayName":"SFA Videos",
"mail":"SFAVideos@service.contoso.com",
"mailNickname":"SFAVideos"
}
]
}
Example 4: Use OData cast and $filter to get membership with a display name that starts with the letter 'A' including a count of returned objects
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/devices/{id}/memberOf/microsoft.graph.group?$count=true&$orderby=displayName&$filter=startswith(displayName, 'A')
ConsistencyLevel: eventual
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#directoryObjects",
"@odata.count":76,
"value":[
{
"displayName":"AAD Contoso Videos",
"mail":"AADContosoVideos@contoso.com",
"mailEnabled":true,
"mailNickname":"AADContoso_Videos",
"securityEnabled":true
}
]
}