プラットフォーム管理 API
ホスト専用のクロステナントエンドポイント: テナント、ホスト設定、ダッシュボード&モニタリング、エディションと機能。
対象範囲
このページのエンドポイントは、通常のテナント階層の 上位 に位置します。これらはよく知られた ホスト テナントに属し、すべてのテナントを横断して動作します — テナントの作成とリカバリー、プラットフォーム全体のデフォルト設定、インスタンスのモニタリング、そしてテナントが利用できる機能を制御するエディションと機能の定義などです。
これらのルートは ホストガード によって保護されており、ホストトークン — ホストテナントのメンバーであり、少なくとも 1 つの Host.* 権限を持つ認証済みユーザー — が必要です。通常のテナント内では利用できません。呼び出し元は、さらに各領域に固有の権限が必要です: Host.Tenants.*、Host.Settings.*、Host.Editions.*、Host.Dashboard.Read。
テナント
テナントのライフサイクル、ユーザーリカバリー、エディションの利用可否。Host.Tenants.*(Create、Read、Update、Delete、Impersonate、ManageUsers)によって制御されます — ManageUsers は意図的に Impersonate と区別されており、リカバリー操作を個別に監査できるようになっています。
| メソッド + パス | 目的 |
|---|---|
GET · POST /api/tenants | テナントの一覧取得 · 作成 |
GET · PUT · DELETE /api/tenants/{id} | テナントの管理 |
POST /api/tenants/{id}/toggle | テナントの有効化・無効化 |
GET /api/tenants/{id}/features | テナントの実効機能 |
GET /api/tenants/{id}/users | テナントのユーザー一覧取得 |
POST /api/tenants/{id}/impersonate | テナントのホストインパーソネーション |
POST /api/tenants/{id}/users/{user_id}/unlock · reset-mfa · reset-password | ホスト側でのユーザーリカバリー |
GET /api/tenants/{id}/available-editions | テナントが移行可能なエディション |
ホスト設定
プラットフォーム全体のデフォルト設定(一般、セキュリティ、メール、請求)に加え、個々のテナント設定に対するホスト管理のオーバーライド。Host.Settings.{Read,Update} によって制御されます。
| メソッド + パス | 目的 |
|---|---|
GET · PUT /api/host-settings | ホスト設定の読み取り/更新 |
GET · PUT /api/settings/host | ホスト設定(設定モジュール) |
GET · PUT /api/settings/tenants/{id} | ホスト管理によるテナントごとの設定 |
ダッシュボードとモニタリング
すべてのテナントを横断する運用ビュー。Host.Dashboard.Read によって制御されます。
| メソッド + パス | 目的 |
|---|---|
GET /api/host/dashboard | プラットフォーム全体のサマリー |
GET /api/host/tenants/monitoring | テナント横断の運用 KPI |
GET /api/host/tenants/{id}/monitoring | テナントごとの運用 KPI |
エディション
データ駆動型の製品ティア — 機能エンタイトルメント、数値上限、可視性。Host.Editions.{Create,Read,Update,Delete} によって制御されます。
| メソッド + パス | 目的 |
|---|---|
GET · POST /api/editions | エディションの一覧取得 · 作成 |
GET · PUT · DELETE /api/editions/{id} | エディションの管理 |
GET · PUT /api/editions/{id}/features | エディションの機能値の読み取り/設定 |
GET · PUT /api/editions/{id}/tenants | エディションの可視性許可リスト |
GET /api/features | すべての機能定義の一覧取得 |
機能
機能定義は読み取り専用のメタデータであり、値はエディション上で管理されます(テナントごとのオーバーライドはありません)。Host.Features.* / Host.Editions.* によって制御されます。
| メソッド + パス | 目的 |
|---|---|
GET /api/features | すべての機能定義の一覧取得 |
GET · PUT /api/editions/{id}/features | エディションの機能値の読み取り/設定 |
GET /api/tenants/{id}/features | テナントの実効機能 |
機能 は、テナントのエディションにその能力が存在するかどうかを決め、権限 は、特定のユーザーがそれを使用できるかどうかを決めます。ホスト呼び出しは、ホストガードを通過し、必要な Host.* 権限を保持し、該当する場合は、その機能を有効化しているエディションのテナントを対象とする必要があります。