列出目录角色的成员

命名空间:microsoft.graph

检索分配给目录角色的主体列表。

可以将 directoryRole 的对象 ID 和模板 ID 用于此 API。 内置角色的模板 ID 是不可变的,可以在Microsoft Entra 管理中心上的角色说明中看到。 有关详细信息,请参阅 角色模板 ID

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

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

权限

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

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

当应用程序查询返回 directoryObject 类型集合的关系时,如果应用程序没有读取特定派生类型 ((如设备) )的权限,则会返回该类型的成员,但信息有限。 通过此行为,应用程序可以请求所需的最低特权权限,而不是依赖于 目录集。*权限。 有关详细信息,请参阅为不可访问的成员对象返回有限的信息

HTTP 请求

可以使用目录角色 IDroleTemplateId 来寻址目录角色。

GET /directoryRoles/{role-id}/members
GET /directoryRoles(roleTemplateId='{roleTemplateId}')/members

可选的查询参数

此方法支持 $selectOData 查询参数 来帮助自定义响应。 它默认返回 1,000 个对象,不支持使用 $top分页。

请求标头

名称 类型 说明
Authorization string 持有者 {token}。 必填。

请求正文

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

响应

如果成功,此方法在响应正文中返回 200 OK 响应代码和 directoryObject 对象集合。

示例

示例 1:使用角色 ID 获取目录角色的成员

请求

GET https://graph.microsoft.com/v1.0/directoryRoles/43a63cc2-582b-4d81-a79d-1591f91d5558/members

响应

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

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "businessPhones":["000-000-0000"],
      "displayName":"Adele Vance",
      "givenName":"Adele",
      "jobTitle":null,
      "mail":"AdeleV@contoso.com",
      "officeLocation":null,
      "preferredLanguage":"en-US",
      "surname":"Vance",
      "userPrincipalName":"AdeleV@contoso.com"
    }
  ]
}

示例 2:使用 roleTemplateId 获取目录角色的成员

请求

GET https://graph.microsoft.com/v1.0/directoryRoles(roleTemplateId='43a63cc2-582b-4d81-a79d-1591f91d5558')/members

响应

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

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "businessPhones":["000-000-0000"],
      "displayName":"Adele Vance",
      "givenName":"Adele",
      "jobTitle":null,
      "mail":"AdeleV@contoso.com",
      "officeLocation":null,
      "preferredLanguage":"en-US",
      "surname":"Vance",
      "userPrincipalName":"AdeleV@contoso.com"
    }
  ]
}