List servicePrincipal memberOf
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
获取此 servicePrincipal 作为直接成员所属的组和目录角色。 此操作不可传递。
此 API 可用于以下国家级云部署。
全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 | 最低特权权限 | 更高特权权限 |
---|---|---|
委派(工作或学校帐户) | Application.Read.All | Application.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All |
委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
应用程序 | Application.Read.All | Application.ReadWrite.All、Application.ReadWrite.OwnedBy、Directory.Read.All、Directory.ReadWrite.All |
重要
当应用程序查询返回 directoryObject 类型集合的关系时,如果它没有读取特定资源类型的权限,则会返回该类型的成员,但信息有限。 例如,仅返回对象类型和 ID 的 @odata.type 属性,而其他属性则指示为 null
。 通过此行为,应用程序可以请求所需的最低特权权限,而不是依赖于 目录集。*权限。 有关详细信息,请参阅为不可访问的成员对象返回有限的信息。
HTTP 请求
GET /servicePrincipals/{id}/memberOf
可选的查询参数
此方法支持OData query parameters以帮助自定义响应,包括 $select
、$search
、 和 $count
还启用了 OData 强制转换,例如,你可以强制转换为仅获取用户所属的 directoryRoles。
$search
可以用在 displayName属性。 默认和最大页面大小分别为 100 和 999 个对象。
请求标头
名称 | 类型 | 说明 |
---|---|---|
Authorization | string | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
ConsistencyLevel | 最终。 使用 $search 、$filter 、$orderby 或 OData 强制转换查询参数时,此标头和 $count 是必需的。 它使用的索引可能与对象的最新更改不同步。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法会在响应正文中返回 200 OK
响应代码和 directoryObject 对象集合。
示例
示例 1:获取此服务主体作为直接成员所属的组和目录角色
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/servicePrincipals/{id}/memberOf
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"@odata.type": "#microsoft.graph.group",
"id": "id-value",
"createdDateTime": null,
"description": "All users at the company",
"displayName": "All Users",
"groupTypes": [],
"mailEnabled": false,
"securityEnabled": true,
}
]
}
示例 2:仅获取所有可成员身份的计数
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/servicePrincipals/{id}/memberOf/$count
ConsistencyLevel: eventual
响应
以下示例显示了相应的响应。
HTTP/1.1 200 OK
Content-type: text/plain
394
示例 3:使用 OData 强制转换以仅获取组成员身份的计数
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/servicePrincipals/{id}/memberOf/microsoft.graph.group/$count
ConsistencyLevel: eventual
响应
以下示例显示了相应的响应。
HTTP/1.1 200 OK
Content-type: text/plain
394
示例 4:使用 $search 和 OData 强制转换获取显示名称中包含字母“Video”(包括返回的对象数)的组成员身份
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/servicePrincipals/{id}/memberOf/microsoft.graph.group?$count=true&$orderby=displayName&$search="displayName:Video"
ConsistencyLevel: eventual
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#directoryObjects",
"@odata.count":1396,
"value": [
{
"@odata.type": "#microsoft.graph.group",
"id": "id-value",
"createdDateTime": null,
"description": "All videos for the company",
"displayName": "All Videos",
"groupTypes": [],
"mailEnabled": false,
"securityEnabled": true
}
]
}
示例 5:使用 $filter 和 OData 强制转换获取显示名称以字母“A”开头(包括返回的对象数)的组成员身份
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/servicePrincipals/{id}/memberOf/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/beta/$metadata#directoryObjects",
"@odata.count":76,
"value":[
{
"@odata.type": "#microsoft.graph.group",
"id": "id-value",
"createdDateTime": null,
"description": "All videos for the company",
"displayName": "All Videos",
"groupTypes": [],
"mailEnabled": false,
"securityEnabled": true
}
]
}