获取 directoryRole

项目
10/26/2024

命名空间：microsoft.graph

注意

Microsoft建议使用统一的 RBAC API 而不是此 API。统一的 RBAC API 提供更多的功能和灵活性。有关详细信息，请参阅获取 unifiedRoleDefinition。

检索 directoryRole 对象的属性。必须在租户中激活角色才能成功响应。

可以将 directoryRole 的对象 ID 和模板 ID 用于此 API。内置角色的模板 ID 是不可变的，可以在Microsoft Entra 管理中心上的角色说明中看到。有关详细信息，请参阅角色模板 ID。

全局服务	美国政府 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

重要

在具有工作或学校帐户的委托方案中，必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。此操作支持以下最低特权角色。

用户管理员
帮助台管理员
服务支持管理员
帐务管理员
用户
邮箱管理员
目录读取器
目录作者
应用程序管理员
安全读取者
安全管理员
特权角色管理员
云应用程序管理员
客户密码箱访问审批者
Dynamics 365管理员
Power BI 管理员
Azure 信息保护管理员
桌面分析管理员
许可证管理员
Microsoft托管桌面管理员
身份验证管理员
特权身份验证管理员
Teams 通信管理员
Teams 通信支持工程师
Teams 通信支持专家
Teams 管理员
Insights 管理员
合规数据管理员
安全操作员
Kaizala 管理员
全局读取者
批量许可业务中心用户
批量许可服务中心用户
新式商务管理员
适用于企业的 Microsoft Store用户
目录审阅者

HTTP 请求

可以使用目录角色 ID 或 roleTemplateId 来寻址目录角色。

GET /directoryRoles/{role-id}
GET /directoryRoles(roleTemplateId='{roleTemplateId}')

可选的查询参数

此方法支持 $selectOData 查询参数来帮助自定义响应。

请求标头

名称	类型	说明
Authorization	string	持有者 {token}。必填。详细了解身份验证和授权。

请求正文

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

响应

如果成功，此方法在响应正文中返回 200 OK 响应代码和 directoryRole 对象。

示例

示例 1：使用角色 ID 获取目录角色的定义

请求

GET https://graph.microsoft.com/v1.0/directoryRoles/43a63cc2-582b-4d81-a79d-1591f91d5558


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DirectoryRoles["{directoryRole-id}"].GetAsync();



mgc directory-roles get --directory-role-id {directoryRole-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
directoryRoles, err := graphClient.DirectoryRoles().ByDirectoryRoleId("directoryRole-id").Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DirectoryRole result = graphClient.directoryRoles().byDirectoryRoleId("{directoryRole-id}").get();


const options = {
	authProvider,
};

const client = Client.init(options);

let directoryRole = await client.api('/directoryRoles/43a63cc2-582b-4d81-a79d-1591f91d5558')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->directoryRoles()->byDirectoryRoleId('directoryRole-id')->get()->wait();


Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgDirectoryRole -DirectoryRoleId $directoryRoleId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.directory_roles.by_directory_role_id('directoryRole-id').get()

响应

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"
}

通过