Documentation index for AI agents

GS2-Identifier API リファレンス

クレデンシャル管理機能

GS2にアクセスするためのクレデンシャルや権限管理をおこないます。

GS2にアクセスするときにはクレデンシャルを使用してAPIを呼び出します。
その際にはクレデンシャルの所有者であるユーザーに割り当てられたセキュリティポリシーに基づいて処理されます。
複数のセキュリティポリシーをユーザーに割り当てている場合、いずれかのセキュリティポリシーによって操作が許可されていればAPIを利用できます。

またマネージメントコンソールログインパスワードを作成することで複数人で1つのプロジェクトを管理できます。

GS2-Identifier は、クラウドサービスにおける IAM (Identity and Access Management) に相当する概念を提供します。

セキュリティポリシーは、JSON 形式で記述された権限定義です。許可するリソース GRN と、許可するアクション (Gs2Account:CreateAccount のような操作識別子) を記述することで、そのポリシーがアタッチされたユーザーに対してどのような操作を許可するかを表現します。

ユーザーに対して発行されるクライアントIDとクライアントシークレットは、GS2 API を呼び出す際の認証情報として利用されます。1ユーザーに対して複数のクレデンシャルを発行することができ、用途やデバイスに応じて使い分けることができます。

例外的に、ユーザーに対するログイン (Project Token の発行) をアプリケーション側で実行するケースがあります。組み込みのクライアントID / クライアントシークレットを用いて Login API を呼び出し、取得した Project Token を GS2 API の認証情報として利用することで、ユーザーに紐づくセキュリティポリシーの範囲で API を呼び出せます。
Login API は、ゲームエンジン用 SDK の Domain 経由ではなく、各種言語向けの一般 SDK (C# / Go / Python / TypeScript / PHP / Java) を用いて呼び出してください。

GS2-Version と組み合わせると、権限の段階的な付与を実現できます。アプリケーションに組み込むクレデンシャルにはログインとバージョンチェックを実行できる程度の弱い権限だけを与えておき、バージョンチェックを通過したあとに Project Token を発行することで、ゲーム本編はより強い権限でアクセスする、といった構成が可能です。


GS2-Identifier SDK API リファレンス

各種プログラミング言語向け GS2-Identifier SDK の モデルの仕様 と API のリファレンス

GS2-Identifier Deploy/CDK リファレンス

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例