directoryRoleTemplate リソース型

名前空間: microsoft.graph

注:

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

ディレクトリ ロール テンプレートを表します。 ディレクトリ ロール テンプレートでは、ディレクトリ ロール (directoryRole) のプロパティ値を指定します。 テナントでアクティブ化できるディレクトリ ロールごとに、関連付けられているディレクトリ ロール テンプレート オブジェクトがあります。 ディレクトリ ロールを読み取る場合や、そのメンバーを更新する場合は、まず、そのディレクトリ ロールをテナントでアクティブにする必要があります。 既定では、会社の管理者 (Company Administrators) ディレクトリ ロールのみがアクティブ化されています。 他の使用可能なディレクトリ ロールをアクティブにするには、要求 /directoryRoles の roleTemplateId パラメーターでディレクトリ ロールのベースが指定されているディレクトリ ロール テンプレートの ID を使用して、POST 要求をエンドポイントに送信します。 この ID は、要求の roleTemplateId パラメーターで指定したディレクトリ ロールに基づきます。 この要求が正常に完了すると、ディレクトリ ロールの読み取りや、ディレクトリ ロールへのメンバーの追加ができるようになります。注:ディレクトリ ロール テンプレートは、ユーザー (Users) ディレクトリ ロールに公開されます。 Users ディレクトリ ロールは暗黙的であり、ディレクトリ クライアントには表示されません。 テナント内のすべてのユーザーは、インフラストラクチャによって、このロールに割り当てられます。 このロールは、あらかじめアクティブ化されています。 このテンプレートは使用しないでください。

メソッド

メソッド	戻り値の型	説明
Get	directoryRoleTemplate	directoryRoleTemplate オブジェクトのプロパティとリレーションシップを読み取ります。
List	directoryRoleTemplate コレクション	directoryRoleTemplate オブジェクトのリストを取得します

プロパティ

プロパティ	型	説明
description	String	ディレクトリ ロールに設定する説明。 読み取り専用。
displayName	String	ディレクトリ ロールに設定する表示名。 読み取り専用。
id	String	テンプレートの一意識別子。 directoryObject から継承されます。 POST 要求で roleTemplateId プロパティのディレクトリ ロール テンプレートの ID を指定すると、テナントで directoryRole がアクティブ化されます。 Key、Null 許容ではありません。 読み取り専用です。

リレーションシップ

なし

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
  "description": "string",
  "displayName": "string",
  "id": "string (identifier)"
}