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]Open ID 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"
        ]
      }
    }
  ]
}
TypeConditionRequireDefaultLimitationDescription
version
2024-07-30Format version of master data
takeOverTypeModelsList<TakeOverTypeModel>~ 1000 itemsType of take-over information

TakeOverTypeModel

Type of take-over information

TypeConditionRequireDefaultLimitationDescription
takeOverTypeModelIdstring
~ 1024 charsType of take-over model GRN
typeint
~ 1024Slot Number
metadatastring~ 2048 charsmetadata
openIdConnectSettingOpenIdConnectSetting
OpenID Connect Configuration

OpenIdConnectSetting

OpenID Connect Configuration

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

TypeConditionRequireDefaultLimitationDescription
configurationPathstring
~ 1024 charsOpen ID Connect Configuration URL
clientIdstring
~ 1024 charsClient ID
clientSecretstring{configurationPath} != “https://appleid.apple.com/.well-known/openid-configuration”
~ 1024 charsClient Secret
appleTeamIdstring{configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration”
~ 1024 charsTeam ID of Apple Developer
appleKeyIdstring{configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration”
~ 1024 charsKey ID registered with Apple
applePrivateKeyPemstring{configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration”
~ 10240 charsPrivate Key received from Apple
doneEndpointUrlstring~ 1024 charsURL to transition to when authentication is complete
additionalScopeValuesList<ScopeValue>[]~ 10 itemsAdditional scopes obtained with OpenId Connect
additionalReturnValuesList<string>[]~ 10 itemsAdditional return values obtained with OpenId Connect

ScopeValue

Scope value

TypeConditionRequireDefaultLimitationDescription
keystring
~ 64 charsName
valuestring~ 51200 charsValue

PlatformUser

Platform user information

TypeConditionRequireDefaultLimitationDescription
typeint
~ 1024Slot Number
userIdentifierstring
~ 1024 charsUser ID on various platforms
userIdstring
~ 128 charsUser Id