Get directoryRole

[アーティクル]
10/26/2024

名前空間: microsoft.graph

注:

Microsoft では、この API の代わりに統合 RBAC API を使用することをお勧めします。統合 RBAC API は、より多くの機能と柔軟性を提供します。詳細については、「 UnifiedRoleDefinition を取得する」を参照してください。

directoryRole オブジェクトのプロパティを取得します。応答を成功させるには、テナントでロールをアクティブにする必要があります。

この API では、 directoryRole のオブジェクト ID とテンプレート ID の両方を使用できます。組み込みロールのテンプレート ID は不変であり、Microsoft Entra 管理センターのロールの説明で確認できます。詳細については、「ロールテンプレート ID」を参照してください。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	✅

アクセス許可

この 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ロールまたはサポートされているロールのアクセス許可を持つカスタムロールを割り当てる必要があります。この操作では、次の最小特権ロールがサポートされています。

ユーザー管理者
ヘルプデスク管理者
サービスサポート管理者
課金管理者
User
メールボックスの管理者
ディレクトリリーダー
ディレクトリ製作者
アプリケーション管理者
セキュリティ閲覧者
セキュリティ管理者
特権ロール管理者
クラウドアプリケーション管理者
カスタマーロックボックスアクセス承認者
Dynamics 365管理者
Power BI 管理者
Azure Information Protection 管理者
Desktop Analytics管理者
ライセンス管理者
Microsoft マネージドデスクトップ管理者
認証管理者
特権認証管理者
Teams 通信管理者
Teams 通信サポートエンジニア
Teams 通信サポートスペシャリスト
Teams 管理者
Insights 管理者
コンプライアンスデータ管理者
セキュリティオペレーター
Kaizala 管理者
グローバル閲覧者
ボリュームライセンスビジネスセンターユーザー
ボリュームライセンス Service Center ユーザー
モダンコマース管理者
ビジネス向け Microsoft Store ユーザー
ディレクトリレビュー担当者

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


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

次の方法で共有

Get directoryRole

アクセス許可

HTTP 要求

オプションのクエリパラメーター

要求ヘッダー

要求本文

応答

例

例 1: ロール ID を使用してディレクトリロールの定義を取得する

要求

応答

例 2: roleTemplateId を使用してディレクトリロールの定義を取得する

要求

応答

フィードバック

その他のリソース

次の方法で共有

Get directoryRole

アクセス許可

HTTP 要求

オプションのクエリ パラメーター

要求ヘッダー

要求本文

応答

例

例 1: ロール ID を使用してディレクトリ ロールの定義を取得する

要求

応答

例 2: roleTemplateId を使用してディレクトリ ロールの定義を取得する

要求

応答

フィードバック

その他のリソース

オプションのクエリパラメーター

例 1: ロール ID を使用してディレクトリロールの定義を取得する

例 2: roleTemplateId を使用してディレクトリロールの定義を取得する