directoryRoleTemplate リソース型

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

メソッド

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

プロパティ

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

リレーションシップ

なし

JSON 表記

以下は、リソースの JSON 表記です

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