Edit

Share via

List members

  • Article

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.

Use this API to get the members list (users, groups, and devices) in an administrative unit.

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) AdministrativeUnit.Read.All AdministrativeUnit.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application AdministrativeUnit.Read.All AdministrativeUnit.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.

Note

To view the members with a hidden membership in an administrative unit, the app must be granted the Member.Read.Hidden delegated or application permission.

Important

In delegated scenarios with work or school accounts, the signed-in user must be a member user or 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 - Read basic properties and members of administrative units
  • Global Reader - Read all properties of administrative units, including members
  • Privileged Role Administrator - Fully manage administrative units, including members, but excluding restricted administrative units. For more information, see Restricted management administrative units in Microsoft Entra ID

HTTP request

GET /administrativeUnits/{id}/members
GET /administrativeUnits/{id}/members/$ref

Optional query parameters

This method (when used without $ref) supports the OData query parameters to help customize the response, including $search, $count, and $filter. OData cast is also enabled, for example, you can cast to get just the users that are a member of the administrative unit.

$search is supported on the displayName and description properties only. 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, 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 a collection of user, group, or device objects in the response body. Adding $ref at the end of the request returns a collection of only @odata.id URLs of the members.

Examples

Example 1: List member objects

Request

The following request will list the members of the administrative unit, returning a collection of users and/or groups.

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members

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.user",
      "id":"492c5308-59fd-4740-9c83-4b3db07a6d70"
      "accountEnabled":true,
      "businessPhones":[],
      "companyName":null,
      "displayName":"Demo User"
    },
    {
      "@odata.type":"#microsoft.graph.group",
      "id":"07eaa5c7-c9b6-45cf-8ff7-3147d5122caa",
      "description":"This group is the best ever",
      "displayName":"Awesome group"
    }
  ]
}

Example 2: List member references

Request

The following request will list the member references of the administrative unit, returning a collection of @odata.id references to the members.

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members/$ref

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.id": "https://graph.microsoft.com/beta/directoryObjects/492c5308-59fd-4740-9c83-4b3db07a6d70"
    },
    {
      "@odata.id": "https://graph.microsoft.com/beta/directoryObjects/07eaa5c7-c9b6-45cf-8ff7-3147d5122caa"
    }
  ]
}