テナントAPI
mindzieStudioのシステムレベルのテナント管理操作。プラットフォーム全体のテナントの作成、一覧表示、更新、削除を行います。
重要: すべてのテナントAPIエンドポイントはグローバルAPIキーが必要です。テナント固有の通常のAPIキーではこれらのエンドポイントにアクセスできません。
機能
管理
すべてのテナントの一覧表示、テナントの詳細取得、新規テナントの作成、テナント設定の更新。ユーザー制限、ケース制限、テナントプロパティの構成が可能です。
削除
安全のための三重確認付きでテナントを完全削除します。データエクスポートのベストプラクティスおよび安全な削除ワークフローを含みます。
利用可能なエンドポイント
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /api/tenant |
すべてのテナントを一覧表示 |
| GET | /api/tenant/{tenantId} |
IDでテナントを取得 |
| POST | /api/tenant |
テナントを作成 |
| PUT | /api/tenant |
テナントを更新 |
| DELETE | /api/tenant |
テナントを削除 |
テナントオブジェクトのフィールド
| フィールド | 型 | 説明 |
|---|---|---|
tenantId |
GUID | テナントの一意の識別子 |
name |
string | 一意のシステム名（URLで使用） |
displayName |
string | 人間にわかりやすい表示名 |
description |
string | テナントの説明 |
caseCount |
integer | ケースの総数 |
maxUserCount |
integer | 許可された最大ユーザー数 |
maxAnalystCount |
integer | 許可された最大アナリスト数 |
userCount |
integer | 現在のユーザー数 |
analystCount |
integer | 現在のアナリスト数 |
isDisabled |
boolean | テナントが無効かどうか |
isAcademic |
boolean | 学術用テナントかどうか |
preRelease |
boolean | テナントがプレリリース機能を有しているか |
dateCreated |
datetime | テナントが作成された日時 |
認証
| エンドポイント | APIキータイプ | アクセス |
|---|---|---|
すべての /api/tenant エンドポイント |
グローバルAPIキー | 必須 |
| テナントAPIキー | 401 Unauthorized |
グローバルAPIキーは管理画面の/admin/global-api-keysから作成可能です。
APIキーの種類と使用方法の詳細は認証を参照してください。
クイックスタート
# すべてのテナントを一覧表示（グローバルAPIキー必須）
curl -X GET "https://your-mindzie-instance.com/api/tenant" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
# 特定のテナントを取得
curl -X GET "https://your-mindzie-instance.com/api/tenant/{tenantId}" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
重要な注意点
- グローバルAPIキーのみ：すべてのテナントエンドポイントはグローバルAPIキーが必要です
- ライセンス制限：テナント数がライセンス制限内であるか監視してください
- 破壊的操作：テナントの削除は永続的かつ取り消し不可です
- 三重確認：削除操作にはID、名前、表示名が完全に一致している必要があります
- 無効化と削除の違い：データを保持しアクセスを防ぐためにはテナントを無効化することを検討してください