directoryRole リソース型
名前空間: microsoft.graph
Microsoft Entra ディレクトリ ロールを表します。 Microsoft Entraディレクトリ ロールは、管理者ロールとも呼ばれます。 ディレクトリ (管理者) ロールの詳細については、「Microsoft Entra管理者ロールの割り当て」を参照してください。 Microsoft Graph では、ユーザーにディレクトリ ロールを割り当てることで、ターゲット ロールのアクセス許可をユーザーに付与できます。 ディレクトリ ロールを読み取る場合や、そのメンバーを更新する場合は、まず、そのディレクトリ ロールをテナントでアクティブにする必要があります。 既定では、会社の管理者 (Company Administrators) ディレクトリ ロールのみがアクティブ化されています。 その他の使用可能なディレクトリ ロールをアクティブ化するには、directoryRoleTemplate の ID を使用して POST 要求を送信します。この ID は、ディレクトリ ロールに基づきます。 ディレクトリ ロール テンプレートを一覧表示し、他の使用可能なすべてのディレクトリ ロールを取得します。 directoryObject から継承します。
このリソースは以下をサポートしています。
メソッド
メソッド | 戻り値の型 | 説明 |
---|---|---|
ディレクトリ ロールを取得する | directoryRole | directoryRole オブジェクトのプロパティとリレーションシップを読み取ります。 |
ディレクトリ ロールを一覧表示する | directoryRole コレクション | テナントでアクティブになっているディレクトリ ロールを一覧表示します。 |
メンバーを追加する | directoryObject | members ナビゲーション プロパティを送信することで、ユーザーをディレクトリ ロールに追加します。 |
List members | directoryObject コレクション | members ナビゲーション プロパティから、ディレクトリ ロールのメンバーであるユーザーを取得します。 |
メンバーを削除する | directoryObject | ディレクトリ ロールからユーザーを削除します。 |
ディレクトリ ロールをアクティブ化する | directoryRole | ディレクトリ ロールをアクティブにします。 |
スコープ付きメンバーを一覧表示する | scopedRoleMembership コレクション | scopedRoleMembership リソース コレクションを通して、管理単位を範囲とした、このディレクトリ ロールのメンバーを表示します。 |
Get delta | directoryRole コレクション | ディレクトリ ルールの増分の変更を取得します。 |
プロパティ
プロパティ | 種類 | 説明 |
---|---|---|
description | String | ディレクトリ ロールの説明。 読み取り専用。
$filter (eq ), $search , $select をサポートしています。 |
displayName | 文字列 | ディレクトリ ロールの表示名。 読み取り専用。
$filter (eq ), $search , $select をサポートしています。 |
id | 文字列 | ディレクトリ ロールの一意識別子。directoryObject から継承されます。 キーであり、Null は許容されません。 読み取り専用です。
$filter (eq ), $select をサポートしています。 |
roleTemplateId | String | このロールが基づいている directoryRoleTemplate の id。 このプロパティは、POST 操作でテナント内のディレクトリ ロールをアクティブ化するときに指定する必要があります。 そのディレクトリ ロールがアクティブ化されると、このプロパティは読み取り専用になります。
$filter (eq ), $select をサポートしています。 |
リレーションシップ
リレーションシップ | 型 | 説明 |
---|---|---|
members | directoryObject コレクション | このディレクトリ ロールのメンバーであるユーザー。 HTTP メソッド: GET、POST、DELETE。 読み取り専用です。 Null 許容型。
$expand をサポートします。 |
scopedMembers | scopedRoleMembership コレクション | 管理単位を範囲とした、このディレクトリ ロールのメンバー。 読み取り専用。 Null 許容型。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"description": "string",
"displayName": "string",
"id": "string (identifier)",
"roleTemplateId": "string"
}