プロジェクトおよびユーザー管理 API リファレンス
GIIPプラットフォーム内のプロジェクト情報を照会し、ユーザー権限をプログラムから管理する API を案内します。
📋 概要
この API モジュールは、GIIPシステムの論理的な管理単位である プロジェクト(Project) と、該当するプロジェクトにアクセス可能な ユーザー(User) 情報を制御する機能を提供します。
🔐 認証およびヘッダー
すべてのリクエストは、共通の認証ヘッダーを含める必要があります。
- Header:
x-giip-ak: [Your Access Key] - Header:
x-giip-sk: [Your Secret Key]
🚀 主要な API エンドポイント
1. プロジェクト一覧照会 (Get Project List)
- URL:
POST /api/project/list - 説明: 現在のアカウント(CSN)からアクセス可能なすべてのプロジェクト一覧を返します。
- Request Body:
{ "searchKeyword": "" }
2. プロジェクト詳細照会 (Get Project Detail)
- URL:
POST /api/project/detail - 説明: 特定のプロジェクトの詳細設定および割り当てられた資産の数を照会します。
- Request Body:
{ "projectIsn": 123 }
3. プロジェクトユーザー一覧照会 (Get Project Users)
- URL:
POST /api/project/users - 説明: 特定のプロジェクトに割り当てられたユーザーリストとそれぞれの権限レベルを照会します。
- Request Body:
{ "projectIsn": 123 }
🔍 レスポンスデータの例
{ "RstVal": 0, "RstMsg": "Success", "Data": [ { "projectIsn": 123, "projectName": "Mobile App Backend", "userCount": 5, "serverCount": 12, "dbCount": 2 } ] }
💡 活用事例
- CI/CD パイプライン: デプロイ前にターゲットプロジェクトのサーバー一覧を API で受け取り、並列パッケージ更新をトリガーします.
- 権限監査: 定期的にプロジェクトごとのユーザー権限一覧を抽出し、セキュリティレポートを作成します。
🛡️ Sk3(高性能ロギング)の活用
新規プロジェクトの登録やサービスグループの修正など、インフラ全般の構造に影響を与える管理作業において、作業の整合性確保と詳細な監査ログ(Audit Log)のために
giipApiSk3 エンドポイントを推奨します。
- エンドポイント:
https://giipfaw.azurewebsites.net/api/giipApiSk3 - 利点: プロジェクト作成失敗時に呼び出し元の詳細な環境情報(IP, UA)と StackTrace を即座に記録し、設定エラーや権限の問題を迅速に分析できます。
- 活用チップ:
コマンドとtext
のパラメータ置换機能を活用して、複雑なサービスグループの説明や英語以外の名称などを損失なく安全に管理してください。jsondata
バージョン: 1.1 最終更新日: 2026-04-11 ソースファイル:
giipv3/public/help/api-project-user.ja.md
関連ドキュメント: