获取 directoryRole
命名空间:microsoft.graph
检索 directoryRole 对象的属性。 必须在租户中激活角色才能成功响应。
可以将 directoryRole 的对象 ID 和模板 ID 用于此 API。 内置角色的模板 ID 是不可变的,可以在 entra 管理中心Microsoft的角色说明中查看。 有关详细信息,请参阅 角色模板 ID。
此 API 可用于以下国家级云部署。
全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 | 最低特权权限 | 更高特权权限 |
---|---|---|
委派(工作或学校帐户) | RoleManagement.Read.Directory | Directory.Read.All、Directory.ReadWrite.All、RoleManagement.ReadWrite.Directory |
委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
应用程序 | RoleManagement.Read.Directory | Directory.Read.All、Directory.ReadWrite.All、RoleManagement.ReadWrite.Directory |
HTTP 请求
可以使用目录角色 ID 或 roleTemplateId 来寻址目录角色。
GET /directoryRoles/{role-id}
GET /directoryRoles(roleTemplateId='{roleTemplateId}')
可选的查询参数
此方法支持 $select
OData 查询参数 来帮助自定义响应。
请求标头
名称 | 类型 | 说明 |
---|---|---|
Authorization | string | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在响应正文中返回 200 OK
响应代码和 directoryRole 对象。
示例
示例 1:使用角色 ID 获取目录角色的定义
请求
GET https://graph.microsoft.com/v1.0/directoryRoles/43a63cc2-582b-4d81-a79d-1591f91d5558
响应
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryRoles/$entity",
"id": "43a63cc2-582b-4d81-a79d-1591f91d5558",
"deletedDateTime": null,
"description": "Can manage all aspects of Azure AD and Microsoft services that use Azure AD identities.",
"displayName": "Global Administrator",
"roleTemplateId": "62e90394-69f5-4237-9190-012177145e10"
}
示例 2:使用 roleTemplateId 获取目录角色的定义
请求
GET https://graph.microsoft.com/v1.0/directoryRoles(roleTemplateId='43a63cc2-582b-4d81-a79d-1591f91d5558')
响应
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryRoles/$entity",
"id": "43a63cc2-582b-4d81-a79d-1591f91d5558",
"deletedDateTime": null,
"description": "Can manage all aspects of Azure AD and Microsoft services that use Azure AD identities.",
"displayName": "Global Administrator",
"roleTemplateId": "62e90394-69f5-4237-9190-012177145e10"
}
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈