Master Data Reference of GS2-Account

Reference of the format of master data and various models to be imported
{
  "version": "2024-07-30",
  "takeOverTypeModels": [
    {
      "type": "[int]Slot Number",
      "metadata": "[string?]Metadata",
      "openIdConnectSetting": {
        "configurationPath": "[string]OpenID Connect Configuration URL",
        "clientId": "[string]Client ID",
        "clientSecret": "[string]Client Secret",
        "appleTeamId": "[string]Team ID of Apple Developer",
        "appleKeyId": "[string]Key ID registered with Apple",
        "applePrivateKeyPem": "[string]Private Key received from Apple",
        "doneEndpointUrl": "[string?]URL to transition to when authentication is complete",
        "additionalScopeValues": [
          {
            "key": "[string]Name",
            "value": "[string?]Value"
          }
        ],
        "additionalReturnValues": [
          "[string]Additional return values obtained with OpenId Connect"
        ]
      }
    }
  ]
}
TypeConditionRequiredDefaultValue LimitsDescription
version
2024-07-30Format version of master data
takeOverTypeModelsList<TakeOverTypeModel>~ 1000 itemsTakeover type model
This model defines takeover information.

Takeover Setting is information used when changing device models or moving/sharing accounts between platforms.
It consists of a unique string of characters that identifies an individual and a password, the appropriate combination of which can be entered to obtain an Account (anonymous account).

Multiple takeover setting can be set up for one Account.
To set up multiple handover information, you must specify different slots for each.
The number of slots can be from 0 to 1024, which means that a maximum of 1025 different takeover setting can be set.

For example, 0 can be used to store Twitter account information, 1 to store Sign in with Apple account information, and 2 to store Google account information. The following usage is assumed.
This takeover setting is only a data holder, and the authentication mechanism with social accounts needs to be prepared separately.

OpenIdConnectSetting

OpenID Connect Configuration

By registering the settings of an OpenID Connect compliant IdP, you can use IdP integration as account transfer information.

TypeConditionRequiredDefaultValue LimitsDescription
configurationPathstring
~ 1024 charsOpenID Connect Configuration URL
clientIdstring
~ 1024 charsClient ID
clientSecretstring{configurationPath} != “https://appleid.apple.com/.well-known/openid-configuration”
✓*
~ 1024 charsClient Secret
* configurationPath is required for all IdP integrations other than “https://appleid.apple.com/.well-known/openid-configuration”
appleTeamIdstring{configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration”
✓*
~ 1024 charsTeam ID of Apple Developer
* Enabled if configurationPath is “https://appleid.apple.com/.well-known/openid-configuration”
appleKeyIdstring{configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration”
✓*
~ 1024 charsKey ID registered with Apple
* Enabled if configurationPath is “https://appleid.apple.com/.well-known/openid-configuration”
applePrivateKeyPemstring{configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration”
✓*
~ 10240 charsPrivate Key received from Apple
* Enabled if configurationPath is “https://appleid.apple.com/.well-known/openid-configuration”
doneEndpointUrlstring~ 1024 charsURL to transition to when authentication is complete
If not specified, it will transition to /authorization/done.
id_token is attached to the Query String.
additionalScopeValuesList<ScopeValue>[]0 ~ 10 itemsAdditional scopes obtained with OpenId Connect
additionalReturnValuesList<string>[]0 ~ 10 itemsAdditional return values obtained with OpenId Connect

ScopeValue

Scope value

TypeConditionRequiredDefaultValue LimitsDescription
keystring
~ 64 charsName
valuestring~ 51200 charsValue

PlatformUser

Platform user information

TypeConditionRequiredDefaultValue LimitsDescription
typeint
0 ~ 1024Slot Number
userIdentifierstring
~ 1024 charsUser ID on various platforms
userIdstring
~ 128 charsUser Id

TakeOverTypeModel

Takeover type model

This model defines takeover information.

Takeover Setting is information used when changing device models or moving/sharing accounts between platforms. It consists of a unique string of characters that identifies an individual and a password, the appropriate combination of which can be entered to obtain an Account (anonymous account).

Multiple takeover setting can be set up for one Account. To set up multiple handover information, you must specify different slots for each. The number of slots can be from 0 to 1024, which means that a maximum of 1025 different takeover setting can be set.

For example, 0 can be used to store Twitter account information, 1 to store Sign in with Apple account information, and 2 to store Google account information. The following usage is assumed. This takeover setting is only a data holder, and the authentication mechanism with social accounts needs to be prepared separately.

TypeConditionRequiredDefaultValue LimitsDescription
takeOverTypeModelIdstring
~ 1024 charsType of take-over model GRN
typeint
0 ~ 1024Slot Number
metadatastring~ 2048 charsMetadata
openIdConnectSettingOpenIdConnectSetting
OpenID Connect Configuration