List group 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 group is a direct member of.
This operation is not transitive. Unlike getting a user's Microsoft 365 groups, this returns all types of groups, not just Microsoft 365 groups.
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) | GroupMember.Read.All | Directory.Read.All, Directory.ReadWrite.All, Group.Read.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | GroupMember.Read.All | Directory.Read.All, Directory.ReadWrite.All, Group.Read.All |
HTTP request
GET /groups/{id}/memberOf
Optional query parameters
This method supports the OData query parameters to help customize the response, including $select
, $search
, $count
, and $filter
. OData cast is also enabled, for example, you can cast to get just the groups the group is a member of. You can use $search
on the displayName property. The default and maximum page sizes are 100 and 999 objects respectively.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
ConsistencyLevel | eventual. This header and $count are required when using the $search , $filter , $orderby , or OData cast query parameters. It uses an index that might not be up-to-date with recent changes to the object. |
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 and administrative units that the group is a direct member of
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/groups/{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": [
{
"id": "11111111-2222-3333-4444-555555555555",
"mail": "group1@contoso.com",
"mailEnabled": true,
"mailNickname": "Contoso1",
"securityEnabled": true
}
]
}
Example 2: Get only a count of all memberships
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/groups/{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 to get only a count of group membership
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/devices/{id}/memberOf/microsoft.graph.group/$count
ConsistencyLevel: eventual
Response
The following example shows the response.
HTTP/1.1 200 OK
Content-type: text/plain
394
Example 4: 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/groups/{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 5: 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/groups/{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 Users",
"mail":"AADContoso_Users@contoso.com",
"mailEnabled":true,
"mailNickname":"AADContoso_Users",
"securityEnabled":true
}
]
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for