List group transitive members

  • 项目

命名空间：microsoft.graph

获取组成员的列表。 组可以具有不同的对象类型作为成员。 有关不同组支持的成员类型的详细信息，请参阅 组成员身份。

此操作是可传递的，并返回所有嵌套成员的平面列表。 尝试按表示不受支持的成员类型的 OData 强制转换进行筛选会返回代码错误400 Bad RequestRequest_UnsupportedQuery。

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

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

权限

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

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

注意： 若要列出隐藏的成员身份组的成员，需要 Member.Read.Hidden 权限。

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

HTTP 请求

GET /groups/{id}/transitiveMembers

可选的查询参数

此方法支持OData query parameters以帮助自定义响应，包括 $search、$count、 和 $top 可使用“displayName”和“说明”属性上的$search。 还可以根据 OData 类型筛选结果，例如 microsoft.graph.user 或 microsoft.graph.group。

默认情况下，此 API 最多返回 100 个成员对象。 可以通过 $top 查询参数请求的最大页面大小为 999 个对象。

只有将 ConsistencyLevel 标头设置为 eventual 和 $count 时，才支持某些查询。 有关详细信息，请参阅 目录对象的高级查询功能。

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
ConsistencyLevel 最终。 使用 $search、$filter、$orderby 或 OData 强制转换查询参数时，此标头和 $count 是必需的。 它使用的索引可能与对象的最新更改不同步。

请求正文

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

响应

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

尝试按表示不受支持的成员类型的 OData 强制转换进行筛选会返回代码错误400 Bad RequestRequest_UnsupportedQuery。 例如， /groups/{id}}/transitiveMembers/microsoft.graph.group 当组是 Microsoft 365 组时，将返回此错误，因为 Microsoft 365 组不能将其他组作为成员。

示例

示例 1：获取组的可传递成员身份

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/v1.0/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315/transitiveMembers

响应

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

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

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.user",
      "id": "11111111-2222-3333-4444-555555555555",
      "mail": "group1@contoso.com"
    }
  ]
}

示例 2：仅获取可传递成员身份的计数

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/v1.0/groups/{id}/transitiveMembers/$count
ConsistencyLevel: eventual

响应

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

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

HTTP/1.1 200 OK
Content-type: text/plain


893

示例 3：使用 microsoft.graph.group OData 强制转换仅获取属于组的成员

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/v1.0/groups/{id}/transitiveMembers/microsoft.graph.group?$count=true
ConsistencyLevel: eventual

响应

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

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

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": "https://graph.microsoft.com/v2/927c6607-8060-4f4a-a5f8-34964ac78d70/directoryObjects/4d0ef681-e88f-42a3-a2db-e6bf1e249e10/Microsoft.DirectoryServices.Group",
      "id": "4d0ef681-e88f-42a3-a2db-e6bf1e249e10",
      "organizationId": "927c6607-8060-4f4a-a5f8-34964ac78d70",
      "description": null,
      "displayName": "Executives",
      "groupTypes": [],
      "mail": "Executives@contoso.com",
      "mailEnabled": true,
      "mailNickname": "Executives",
    },
    {
      "@odata.id": "https://graph.microsoft.com/v2/927c6607-8060-4f4a-a5f8-34964ac78d70/directoryObjects/d9fb0c47-c783-40a1-bce1-53b52ada51fc/Microsoft.DirectoryServices.Group",
      "id": "d9fb0c47-c783-40a1-bce1-53b52ada51fc",
      "organizationId": "927c6607-8060-4f4a-a5f8-34964ac78d70",
      "displayName": "Project Falcon",
      "groupTypes": [],
      "mail": "Falcon@contoso.com",
      "mailEnabled": true,
      "mailNickname": "Falcon",
    }
  ]
}

示例 4：使用 OData 强制转换和$search获取包含字母“tier”（包括返回对象计数）的显示名称的组中的成员身份

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/v1.0/groups/{id}/transitiveMembers/microsoft.graph.user?$count=true&$orderby=displayName&$search="displayName:tier"&$select=displayName,id
ConsistencyLevel: eventual

响应

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

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

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users(displayName,id)",
  "@odata.count":7,
  "value":[
    {
      "displayName":"Joseph Price",
      "id":"11111111-2222-3333-4444-555555555555"
    }
  ]
}

示例 5：使用 OData 强制转换和$filter获取组中的用户成员身份，其显示名称以“A”开头，包括返回的对象计数

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/v1.0/groups/{id}/transitiveMembers/microsoft.graph.user?$count=true&$orderby=displayName&$filter=startswith(displayName, 'a')
ConsistencyLevel: eventual

响应

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

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

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users",
  "@odata.count":76,
  "value":[
    {
      "displayName":"AAD Contoso Users",
      "mail":"AADContoso_Users@contoso.com"
    }
  ]
}