directoryObject: checkMemberGroups

命名空间:microsoft.graph

重要

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

检查指定 组 ID 列表中的成员身份,并从该列表返回指定对象所属的组的 ID。 指定的对象可以是以下类型之一:

此函数是可传递的。

每个请求最多可检查 20 个组。 此函数支持 Microsoft Entra ID 中预配的所有组。 由于 Microsoft 365 组不能包含其他组,因此 Microsoft 365 组中的成员身份始终是直接的。

重要

Microsoft Graph 将 groupIds 集合评估为单个请求。 如果请求无效 (例如,组 ID) 格式不正确,则整个请求将失败。 如果调用方无权评估某些组 (例如具有隐藏成员身份) 的组,则响应可能仅包括调用方有权评估的组。

注意

响应时间取决于租户的目录结构,包括组嵌套深度和成员身份大小。 Microsoft Graph 不发布可传递成员身份 API 的延迟目标。

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

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

权限

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

目录对象的组成员身份

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

注意

Directory.* 权限允许你通过此 API 检索任何受支持的目录对象类型。 若要仅检索特定类型,可以使用特定于资源的权限。

登录用户的组成员身份

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

其他用户的组成员身份

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

组的组成员身份

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) 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

服务主体的组成员身份

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

组织联系人的组成员身份

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

设备的组成员身份

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

重要

若要评估具有 隐藏成员身份的组中的成员身份,需要额外的访问权限:

  • 应用程序权限:应用必须具有 Member.Read.Hidden 该权限。
  • 委托的权限: 登录用户必须是隐藏成员身份组的成员。

如果这两个条件都不满足,则不会评估隐藏成员身份组,并且这些组 ID 会从响应中省略。

HTTP 请求

目录对象的组成员身份 (用户、组、服务主体或组织联系人) 。

POST /directoryObjects/{id}/checkMemberGroups

已登录用户的组成员身份。

POST /me/checkMemberGroups

其他用户的组成员身份。

POST /users/{id | userPrincipalName}/checkMemberGroups

组的组成员身份。

POST /groups/{id}/checkMemberGroups

服务主体的组成员身份。

POST /servicePrincipals/{id}/checkMemberGroups

组织联系人的组成员身份。

POST /contacts/{id}/checkMemberGroups

设备的组成员身份。

POST /devices/{id}/checkMemberGroups

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json

请求正文

在请求正文中,提供具有以下参数的 JSON 对象。

参数 类型 说明
groupIds String collection 包含检查成员身份的组中的对象 ID 的集合。 可以指定多达 20 个组。

响应

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

示例

示例 1:检查目录对象的组成员身份

请求

POST https://graph.microsoft.com/beta/directoryObjects/4562bcc8-c436-4f95-b7c0-4f8ce89dca5e/checkMemberGroups
Content-type: application/json

{
    "groupIds": [
        "f448435d-3ca7-4073-8152-a1fd73c0fd09",
        "bd7c6263-4dd5-4ae8-8c96-556e1c0bece6",
        "93670da6-d731-4366-94b5-abed40b6016b",
        "f5484ab1-4d4d-41ec-a9b8-754b3957bfc7",
        "c9103f26-f3cf-4004-a611-2a14e81b8f79"
    ]
}

响应

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

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

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(Edm.String)",
    "value": [
        "f448435d-3ca7-4073-8152-a1fd73c0fd09",
        "93670da6-d731-4366-94b5-abed40b6016b",
        "f5484ab1-4d4d-41ec-a9b8-754b3957bfc7",
        "c9103f26-f3cf-4004-a611-2a14e81b8f79"
    ]
}

示例 2:检查已登录用户的组成员身份

请求

POST https://graph.microsoft.com/beta/me/checkMemberGroups
Content-type: application/json

{
  "groupIds": [
        "fee2c45b-915a-4a64-b130-f4eb9e75525e",
        "4fe90ae7-065a-478b-9400-e0a0e1cbd540"
  ]
}

响应

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

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(Edm.String)",
  "value": [
        "fee2c45b-915a-4a64-b130-f4eb9e75525e"
  ]
}