列出用户的成员身份 (直接和可传递)
命名空间:microsoft.graph
通过直接成员身份或可传递成员身份获取用户所属的组、目录角色和管理单元。
此 API 可用于以下国家级云部署。
全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
已登录用户成员身份的权限
权限类型 | 最低特权权限 | 更高特权权限 |
---|---|---|
委派(工作或学校帐户) | User.Read | Directory.Read.All、Directory.ReadWrite.All、Group.Read.All、GroupMember.Read.All、User.Read.All |
委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
应用程序 | 不支持。 | 不支持。 |
其他用户成员身份的权限
权限类型 | 最低特权权限 | 更高特权权限 |
---|---|---|
委派(工作或学校帐户) | User.Read.All | Directory.Read.All、Directory.ReadWrite.All、Group.Read.All、GroupMember.Read.All |
委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
Application | User.Read.All | Directory.Read.All、Directory.ReadWrite.All、Group.Read.All、GroupMember.Read.All |
重要
当应用程序查询返回 directoryObject 类型集合的关系时,如果它没有读取特定资源类型的权限,则会返回该类型的成员,但信息有限。 例如,仅返回对象类型和 ID 的 @odata.type 属性,而其他属性则指示为 null
。 通过此行为,应用程序可以请求所需的最低特权权限,而不是依赖于 目录集。*权限。 有关详细信息,请参阅为不可访问的成员对象返回有限的信息。
提示
- 调用
/me/transitiveMemberOf
终结点需要已登录的用户,因此需要委派权限。 使用/me/transitiveMemberOf
终结点时,不支持应用程序权限。 - 若要列出具有隐藏成员身份的组的成员,
Member.Read.Hidden
需要权限。
HTTP 请求
GET /me/transitiveMemberOf
GET /users/{id | userPrincipalName}/transitiveMemberOf
可选的查询参数
此方法支持OData query parameters以帮助自定义响应,包括 $select
、$search
、 和 $count
此外,还启用了 OData 强制转换,例如,可以强制转换以仅获取组中的可传递成员身份。
$search
可以用在 displayName属性。 默认和最大页面大小分别为 100 和 999 个对象。
请求标头
标头 | 值 |
---|---|
Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
ConsistencyLevel | 最终。 使用 $search 、$filter 、$orderby 或 OData 强制转换查询参数时,此标头和 $count 是必需的。 它使用的索引可能与对象的最新更改不同步。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在响应正文中返回 200 OK
响应代码和 directoryObject 对象集合。
示例
示例 1:获取用户所属的组、目录角色和管理单元
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/v1.0/users/6e7b768e-07e2-4810-8459-485f84f8f204/transitiveMemberOf
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
"value":[
{
"@odata.type":"#microsoft.graph.group",
"displayName":"All_Contoso_Licensing",
"mailEnabled":true,
"mailNickname":"ContosoMailNickName",
"securityEnabled":true
}
]
}
示例 2:仅获取组、目录角色和管理单元中可传递成员身份的计数
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/v1.0/users/{id}/transitiveMemberOf/$count
ConsistencyLevel: eventual
响应
以下示例显示了相应的响应。
HTTP/1.1 200 OK
Content-type: text/plain
893
示例 3:使用 OData 强制转换以仅获取组中可传递成员身份的计数
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/v1.0/users/{id}/transitiveMemberOf/microsoft.graph.group/$count
ConsistencyLevel: eventual
响应
以下示例显示了相应的响应。
HTTP/1.1 200 OK
Content-type: text/plain
588
示例 4:使用 $search 和 OData 强制转换获取包含字母“tier”(包括返回对象计数)的显示名称的组中的可传递成员身份
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/v1.0/users/{id}/transitiveMemberOf/microsoft.graph.group?$count=true&$orderby=displayName&$search="displayName:tier"&$select=displayName,id
ConsistencyLevel: eventual
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#groups(displayName,id)",
"@odata.count":7,
"value":[
{
"displayName":"Contoso-tier Query Notification",
"id":"11111111-2222-3333-4444-555555555555"
}
]
}
示例 5:使用 $filter 和 OData 强制转换在显示名称以“a”开头的组中获取可传递成员身份,包括返回的对象计数
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/v1.0/users/{id}/transitiveMemberOf/microsoft.graph.group?$count=true&$orderby=displayName&$filter=startswith(displayName, 'a')
ConsistencyLevel: eventual
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#groups",
"@odata.count":76,
"value":[
{
"displayName":"AAD Contoso Users",
"mail":"AADContoso_Users@contoso.com",
"mailEnabled":true,
"mailNickname":"AADContoso_Users",
"securityEnabled":true
}
]
}