GS2-Account マスターデータリファレンス
{
"version": "2024-07-30",
"takeOverTypeModels": [
{
"type": "[int]スロット番号",
"metadata": "[string?]メタデータ",
"openIdConnectSetting": {
"configurationPath": "[string]Open ID Connect 設定 URL",
"clientId": "[string]クライアントID",
"clientSecret": "[string]クライアントシークレット",
"appleTeamId": "[string]Apple Developer チームID",
"appleKeyId": "[string]Apple に登録済みのキーID",
"applePrivateKeyPem": "[string]Apple から受け取った秘密鍵",
"doneEndpointUrl": "[string?]認証完了時に遷移するURL"
}
}
]
}
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
version | ✓ | 2024-07-30 | マスターデータのフォーマットバージョン | |||
takeOverTypeModels | List<TakeOverTypeModel> | ~ 1000 items | 引き継ぎ情報モデル |
TakeOverTypeModel
引き継ぎ情報モデル
引継ぎ情報を定義するモデルです。
引継ぎ情報とは、デバイスの機種変更やプラットフォーム間のアカウントの移動・共有時に使用する情報です。
個人を識別するユニークな文字列とパスワードで構成され、その適切な組み合わせを入力することで、Account(匿名アカウント)を取得することができます。
1つの Account に対して複数の引継ぎ情報を設定できます。
複数の引継ぎ情報を設定するにはそれぞれ異なるスロットを指定する必要があります。
スロットには0~1024を指定できますので、最大1025種類の引継ぎ情報を設定可能です。
具体的な用例としては 0 には Twitter のアカウント情報を、1 には Sign-in Apple のアカウント情報を、2 には Google のアカウント情報を保存するようにする。というような使い方が想定されています。
あくまでこの引継ぎ情報はデータホルダーであり、ソーシャルアカウントとの認証の仕組みは別途用意する必要があります。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
takeOverTypeModelId | string | ✓ | ~ 1024文字 | 引き継ぎ情報モデルGRN | ||
type | int | ✓ | ~ 1024 | スロット番号 | ||
metadata | string | ~ 2048文字 | メタデータ | |||
openIdConnectSetting | OpenIdConnectSetting | ✓ | OpenID Connect の設定 |
OpenIdConnectSetting
OpenID Connect の設定
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
configurationPath | string | ✓ | ~ 1024文字 | Open ID Connect 設定 URL | ||
clientId | string | ✓ | ~ 1024文字 | クライアントID | ||
clientSecret | string | {configurationPath} != “https://appleid.apple.com/.well-known/openid-configuration” | ✓ | ~ 1024文字 | クライアントシークレット | |
appleTeamId | string | {configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration” | ✓ | ~ 1024文字 | Apple Developer チームID | |
appleKeyId | string | {configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration” | ✓ | ~ 1024文字 | Apple に登録済みのキーID | |
applePrivateKeyPem | string | {configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration” | ✓ | ~ 10240文字 | Apple から受け取った秘密鍵 | |
doneEndpointUrl | string | ~ 1024文字 | 認証完了時に遷移するURL |
PlatformUser
各種プラットフォームにおけるユーザー情報
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
type | int | ✓ | ~ 1024 | スロット番号 | ||
userIdentifier | string | ✓ | ~ 1024文字 | 各種プラットフォームにおけるユーザーID | ||
userId | string | ✓ | ~ 128文字 | ユーザーID |