ユーザーAPI
mindzieStudioプラットフォーム全体のユーザーを管理します。ユーザーの作成、更新、テナントへの割り当てを柔軟なAPIスコープで行えます。
機能
グローバル操作
グローバルAPIキーによるシステム全体のユーザー管理。全ユーザーの一覧取得、ユーザー作成、プロパティ更新、テナント割当管理が可能です。
テナント操作
グローバルまたはテナントAPIキーで動作するテナントスコープのユーザー管理。特定テナント内のユーザーを管理します。
ロール＆権限
ユーザーロールはアクセスレベルと機能を定義します。ロールの階層構造、サービスアカウント、権限管理のベストプラクティスを理解しましょう。
APIスコープ
ユーザーAPIには2つのスコープがあります：
| スコープ | ベースパス | APIキー必要 |
|---|---|---|
| グローバル | /api/user |
グローバルAPIキー |
| テナントスコープ | /api/tenant/{tenantId}/user |
グローバルまたはテナントAPIキー |
利用可能なエンドポイント
グローバルユーザーエンドポイント
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /api/user |
全ユーザー一覧取得 |
| POST | /api/user |
ユーザー作成 |
| GET | /api/user/{userId} |
ユーザーをIDで取得 |
| PUT | /api/user/{userId} |
ユーザー更新 |
| GET | /api/user/by-email/{email} |
メールアドレスでユーザー取得 |
| GET | /api/user/{userId}/tenants |
ユーザーのテナントを取得 |
テナントスコープユーザーエンドポイント
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /api/tenant/{tenantId}/user |
テナントのユーザー一覧 |
| POST | /api/tenant/{tenantId}/user |
テナント内でユーザー作成 |
| GET | /api/tenant/{tenantId}/user/{userId} |
テナント内のユーザー取得 |
| PUT | /api/tenant/{tenantId}/user/{userId} |
テナント内のユーザー更新 |
| GET | /api/tenant/{tenantId}/user/by-email/{email} |
テナント内でメールアドレスによる取得 |
| POST | /api/tenant/{tenantId}/user/{userId} |
ユーザーをテナントに割り当て |
| DELETE | /api/tenant/{tenantId}/user/{userId} |
テナントから削除 |
ユーザーロール
| ロール（表示名） | APIロール名 | レベル | 説明 |
|---|---|---|---|
| サーバー管理者 | TenantAdmin |
システム | 最上位アクセス。全テナントとサーバー全体にフルアクセス。 |
| 管理者 | Administrator |
テナント | テナント内の完全な管理権限。 |
| IT管理者 | ITAdmin |
テナント | 統合、接続、グローバルAPIキー管理。 |
| アナリスト | Analyst |
プロジェクト | 分析、ダッシュボード、調査の作成と管理。 |
| 開発者 | Developer |
プロジェクト | 統合構築、アクションとアプリの管理。 |
| ユーザー | User |
読み取り専用 | ダッシュボードと分析の閲覧のみ。内容の変更不可。 |
完全なロールガイドはロール＆権限を参照してください。
認証
| エンドポイントスコープ | APIキー種別 | アクセス範囲 |
|---|---|---|
グローバル (/api/user) |
グローバルAPIキー | 全テナント |
| テナントスコープ | グローバルAPIキー | 全テナント |
| テナントスコープ | テナントAPIキー | 所属テナントのみ |
APIキーの種類と使用方法の詳細は認証を参照してください。
クイックスタート
# 全ユーザーを一覧表示（グローバルAPIキー必須）
curl -X GET "https://your-mindzie-instance.com/api/user" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
# テナント内のユーザー一覧（テナントAPIキー可）
curl -X GET "https://your-mindzie-instance.com/api/tenant/{tenantId}/user" \
-H "Authorization: Bearer YOUR_TENANT_API_KEY"
重要な注意点
- グローバルキー vs テナントキー：ほとんどの操作はテナントスコープキーを使い、システム管理はグローバルキーを使用してください
- ユーザー無効化：ユーザー削除ではなく、
disabled: trueを設定して監査ログを保護してください - サービスアカウント：サービスアカウントはサーバー管理者(
TenantAdmin)および管理者ロールのみ許可 - 容量制限：テナントごとにユーザー数とアナリスト数の制限を設定可能