获取组

获取组对象的属性和关系。

默认属性

下面展示了在获取或列出组时返回的一组默认属性。这些默认属性是所有可用属性中的一部分。

  • 说明
  • displayName
  • groupTypes
  • id
  • mail
  • mailEnabled
  • mailNickname
  • onPremisesLastSyncDateTime
  • onPremisesSecurityIdentifier
  • onPremisesSyncEnabled
  • proxyAddresses
  • securityEnabled
  • visibility

默认情况下,不返回下列组属性:

  • allowExternalSenders
  • autoSubscribeNewMembers
  • isSubscribedByMail
  • unseenCount

若要获取这些属性,请使用 $select 查询参数。示例如下:

GET https://graph.microsoft.com/v1.0/groups/c28c1cc9-e1ab-4c4d-98d1-d8fdf128b60f?$select=allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount

GET https://graph.microsoft.com/v1.0/groups/c28c1cc9-e1ab-4c4d-98d1-d8fdf128b60f?$select=description,allowExternalSenders

权限

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

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

HTTP 请求

GET /groups/{id}

可选的查询参数

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

请求标头

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

请求正文

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

响应

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

示例

请求

下面是一个请求示例。

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

下面是一个响应示例。

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

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

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