列出组

列出组织中所有可用的组,包括但不限于 Office 365 组。返回每个组的默认属性

若要仅列出 Office 365 组(亦称为“统一组”),请对 groupTypes 应用筛选器:

GET https://graph.microsoft.com/v1.0/groups?$filter=groupTypes/any(c:c+eq+'Unified')

可以使用 OData 查询选项 $orderby,按 displayName 值对组织中的组进行排序,如下面的示例所示:

GET https://graph.microsoft.com/v1.0/groups?$orderby=displayName

先决条件

若要执行此 API,必须有以下任意一个范围Group.Read.AllGroup.ReadWrite.All

HTTP 请求

GET /groups

可选的查询参数

此方法支持 OData 查询参数 来帮助自定义响应。

请求标头

名称 类型 说明
Authorization string Bearer {token}。必需。

请求正文

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

响应

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

示例

请求

下面是一个请求示例。

GET https://graph.microsoft.com/v1.0/groups
响应

下面是一个响应示例。

注意:为简洁起见,可能会截断此处展示的响应对象。实际调用会返回默认属性

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

 {
  "value": [
    {
      "id": "id-value",
      "description": "description-value",
      "displayName": "displayName-value",
      "groupTypes": [
        "groupTypes-value"
      ],
      "mail": "mail-value",
      "mailEnabled": true,
      "mailNickname": "mailNickname-value",
      "onPremisesLastSyncDateTime": "onPremisesLastSyncDateTime-value",
      "onPremisesSecurityIdentifier": "onPremisesSecurityIdentifier-value",
      "onPremisesSyncEnabled": true,
      "proxyAddresses": [
        "proxyAddresses-value"
      ],
      "securityEnabled": true,
      "visibility": "visibility-value"
    }
  ]
}