列出成员

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

使用此 API 获取管理单元中) (用户、组和设备的成员列表。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) AdministrativeUnit.Read.All AdministrativeUnit.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 AdministrativeUnit.Read.All AdministrativeUnit.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All

重要

当应用程序查询返回 directoryObject 类型集合的关系时,如果它没有读取特定资源类型的权限,则会返回该类型的成员,但信息有限。 例如,仅返回对象类型和 ID@odata.type 属性,而其他属性则指示为 null。 通过此行为,应用程序可以请求所需的最低特权权限,而不是依赖于 目录集。*权限。 有关详细信息,请参阅为不可访问的成员对象返回有限的信息

注意

若要查看在管理单元中具有隐藏成员身份的成员,必须向应用授予 Member.Read.Hidden 委托或应用程序权限。

在具有工作或学校帐户的委托方案中,登录用户必须是成员用户或分配了受支持的 Microsoft Entra 角色 或具有受支持角色权限的自定义角色。 此操作支持以下最低特权角色。

Microsoft Entra 角色 限制 密钥角色权限
目录读取器 读取管理单元的基本属性 microsoft.directory/administrativeUnits/standard/read
目录读取器 读取管理单元的成员 microsoft.directory/administrativeUnits/members/read
全局读取者 读取管理单元的所有属性,包括成员 microsoft.directory/administrativeUnits/allProperties/read
特权角色管理员 创建和管理管理单元 (包括成员) microsoft.directory/administrativeUnits/allProperties/allTasks

HTTP 请求

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

可选的查询参数

此方法在没有) 的情况下 $ref 使用时 (支持 OData 查询参数 来帮助自定义响应,包括 $search$count$filter。 还启用了 OData 强制转换,例如,可以强制转换,以便仅获取属于管理单元成员的用户。

$search 仅在 displayNamedescription 属性上受支持。 只有将 ConsistencyLevel 标头设置为 eventual$count 时,才支持某些查询。 有关详细信息,请参阅 目录对象的高级查询功能

请求标头

标头
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
ConsistencyLevel 最终。 当使用 $search$filter 的特定用法时,需要此标头和 $count。 有关使用 ConsistencyLevel$count的详细信息,请参阅 目录对象的高级查询功能

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此方法在 200 OK 响应正文中返回响应代码和 用户设备 对象的集合。 在请求结束时添加 $ref 仅返回成员 URL 的 @odata.id 集合。

示例

示例 1:列出成员对象

请求

以下请求将列出管理单元的成员,并返回用户和/或组的集合。

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

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

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"
    }
  ]
}

示例 2:列出成员引用

请求

以下请求将列出管理单元的成员引用,并返回对成员的 @odata.id 引用集合。

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

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

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"
    }
  ]
}