反馈 编辑

List group members

  • 项目

命名空间：microsoft.graph

重要

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

获取组的直接成员列表。 组可以将用户、联系人、设备、服务主体和其他组作为成员。 此操作不可传递。

当组包含超过 100 个成员时，Microsoft Graph 将在响应中返回 @odata.nextLink 属性，其中包含指向下一页结果的 URL。 如果该属性存在，请继续使用每次响应中的 @odata.nextLink URL 来创建额外请求，直至返回所有结果，如在应用中对 Microsoft Graph 数据进行分页一文中所述。

权限

要调用此 API，需要以下权限之一。要了解详细信息，包括如何选择权限的信息，请参阅权限。

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

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

当应用程序查询返回 directoryObject 类型集合的关系时，如果它没有读取某种派生类型（如设备）的权限，则会返回该类型的成员，但返回的信息有限。 使用这种行为，应用程序可请求所需的最低特权权限，而不依赖于 Directory.* 集权限。 有关详细信息，请参阅为不可访问的成员对象返回有限的信息。

HTTP 请求

GET /groups/{id}/members

可选的查询参数

此方法支持OData query parameters以帮助自定义响应，包括 $search、$count、 和 $filter 还启用了 OData 强制转换，例如，你可以通过强制转换来获取仅是组成员的用户。 $search可以用在 displayName 属性。 为该资源添加或更新项目时，将对它们进行专门索引，以便与 $count 和 $search 查询参数一起使用。 在添加或更新项目与在索引中可用之间可能会稍有延迟。

请求标头

名称 说明
Authorization Bearer {token}。必需。
ConsistencyLevel 最终。 使用 $search、$filter、$orderby 或 OData 强制转换查询参数时，此标头和 $count 是必需的。 它使用的索引可能与对象的最新更改不同步。

请求正文

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

响应

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

示例

示例1：获取组中的直接成员身份

请求

下面展示了示例请求。

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

响应

下面展示了示例响应。

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

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

示例 2：仅获取所有会员资格的计数

请求

下面展示了示例请求。

GET https://graph.microsoft.com/beta/groups/{id}/members/$count
ConsistencyLevel: eventual

响应

下面展示了示例响应。

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

893

示例 3：使用 OData 强制转换获取仅用户会员资格的计数

请求

下面展示了示例请求。

GET https://graph.microsoft.com/beta/groups/{id}/members/microsoft.graph.user/$count
ConsistencyLevel: eventual

响应

下面介绍响应示例。

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

893

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

请求

下面展示了示例请求。

GET https://graph.microsoft.com/beta/groups/{id}/members/microsoft.graph.user?$count=true&$orderby=displayName&$search="displayName:Pr"&$select=displayName,id
ConsistencyLevel: eventual

响应

下面展示了示例响应。

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

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

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

示例 5：使用 $filter 来获取显示名称以字母 “A” 开头（包括返回的对象数目）的组会员资格

请求

下面展示了示例请求。

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

响应

下面展示了示例响应。

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

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

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#groups",
  "@odata.count":76,
  "value":[
    {
      "displayName":"AAD Contoso Users",
      "mail":"AADContoso_Users@contoso.com",
      "mailEnabled":true,
      "mailNickname":"AADContoso_Users",
      "securityEnabled":true
    }
  ]
}

示例 6：使用 OData 强制转换检索添加为组成员的服务主体

请求

下面展示了示例请求。

GET https://graph.microsoft.com/beta/groups/3802e9bb-0951-4e18-b9eb-f934b4241194/members/microsoft.graph.servicePrincipal

响应

下面展示了示例响应。

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#servicePrincipals",
  "value": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "deletedDateTime": null,
      "accountEnabled": true,
      "appDisplayName": "Contoso Azure App",
      "appId": "11111111-2222-3333-4444-555555555555",
    }
  ]
}