反馈 编辑

获取组

  • 项目

命名空间：microsoft.graph

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

此操作在默认情况下仅返回所有可用属性的一部分，如属性部分中所示。 若要获取 非 默认返回的属性，请在 $select OData 查询选项中指定这些属性。 hasMembersWithLicenseErrors 和 isArchived 属性是一个例外，不会在 $select 查询中返回。

注意： 此请求可能对最近创建、更新或删除的组具有复制延迟。

权限

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

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

注意： 根据你尝试访问的组功能，权限可能会受到限制。 有关详细信息，请参阅 Microsoft Graph 的已知问题中的组部分。

HTTP 请求

GET /groups/{id}

可选的查询参数

可以使用 $select 获取特定组属性，包括非默认返回的属性。

有关 OData 查询选项的详细信息，请参阅 OData 查询参数。

检索扩展和关联数据

扩展类型 备注
架构扩展 仅通过 $select 返回。
开放扩展 通过 获取开放扩展 操作返回。
目录扩展 默认情况下返回。

请求标头

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

请求正文

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

响应

如果成功，此方法在响应正文中返回 200 OK 响应代码和 group 对象。 除非使用 $select 指定特定属性，它会返回默认属性。

示例

示例 1：返回所有默认属性

返回所有默认属性。

请求

下面是一个 GET 请求示例。

GET https://graph.microsoft.com/v1.0/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd

响应

下面是一个响应示例。它仅包括默认属性。

注意： 为了提高可读性，可能缩短了此处显示的响应对象。在实际调用中将返回每个组的所有默认属性。

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity",
    "@odata.id": "https://graph.microsoft.com/v2/84841066-274d-4ec0-a5c1-276be684bdd3/directoryObjects/b320ee12-b1cd-4cca-b648-a437be61c5cd/Microsoft.DirectoryServices.Group",
    "id": "b320ee12-b1cd-4cca-b648-a437be61c5cd",
    "deletedDateTime": null,
    "classification": null,
    "createdDateTime": "2021-09-13T10:07:01Z",
    "creationOptions": [],
    "description": "Self help community for library",
    "displayName": "Library Assist",
    "expirationDateTime": "2022-01-11T10:07:01Z",
    "groupTypes": [
        "Unified"
    ],
    "isAssignableToRole": null,
    "mail": "library@contoso.com",
    "mailEnabled": true,
    "mailNickname": "library",
    "membershipRule": null,
    "membershipRuleProcessingState": null,
    "onPremisesDomainName": null,
    "onPremisesLastSyncDateTime": null,
    "onPremisesNetBiosName": null,
    "onPremisesSamAccountName": null,
    "onPremisesSecurityIdentifier": null,
    "onPremisesSyncEnabled": null,
    "preferredDataLocation": "EU",
    "preferredLanguage": null,
    "proxyAddresses": [
        "SPO:SPO_0dbffe23-f6fb-4478-adcd-880daf88bb12@SPO_84841066-274d-4ec0-a5c1-276be684bdd3",
        "SMTP:library@contoso.com"
    ],
    "renewedDateTime": "2021-09-13T10:07:01Z",
    "resourceBehaviorOptions": [],
    "resourceProvisioningOptions": [],
    "securityEnabled": false,
    "securityIdentifier": "S-1-12-1-1306860066-1319449225-59104187-458188010",
    "theme": null,
    "visibility": "Public",
    "onPremisesProvisioningErrors": []
}

示例 2：通过使用 $select 返回其他属性

通过使用 $select 返回其他属性。

请求

下面是一个 GET 请求示例。

GET https://graph.microsoft.com/v1.0/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd?$select=allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount

响应

下面是一个包括所请求的非默认属性的响应示例。

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups(allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount)/$entity",
    "id": "b320ee12-b1cd-4cca-b648-a437be61c5cd",
    "allowExternalSenders": false,
    "autoSubscribeNewMembers": false,
    "isSubscribedByMail": false,
    "unseenCount": 0
}