Get directoryRole
名前空間: microsoft.graph
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 |
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"
}