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"
]
}
}
]
}
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| version | ✓ | 2024-07-30 | Format version of master data | |||
| takeOverTypeModels | List<TakeOverTypeModel> | ~ 1000 items | Type of take-over information |
TakeOverTypeModel
Type of take-over information
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| takeOverTypeModelId | string | ✓ | ~ 1024 chars | Type of take-over model GRN | ||
| type | int | ✓ | 0 ~ 1024 | Slot Number | ||
| metadata | string | ~ 2048 chars | metadata | |||
| openIdConnectSetting | OpenIdConnectSetting | ✓ | 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.
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| configurationPath | string | ✓ | ~ 1024 chars | Open ID Connect Configuration URL | ||
| clientId | string | ✓ | ~ 1024 chars | Client ID | ||
| clientSecret | string | {configurationPath} != “https://appleid.apple.com/.well-known/openid-configuration” | ✓ | ~ 1024 chars | Client Secret | |
| appleTeamId | string | {configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration” | ✓ | ~ 1024 chars | Team ID of Apple Developer | |
| appleKeyId | string | {configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration” | ✓ | ~ 1024 chars | Key ID registered with Apple | |
| applePrivateKeyPem | string | {configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration” | ✓ | ~ 10240 chars | Private Key received from Apple | |
| doneEndpointUrl | string | ~ 1024 chars | URL to transition to when authentication is complete | |||
| additionalScopeValues | List<ScopeValue> | [] | 0 ~ 10 items | Additional scopes obtained with OpenId Connect | ||
| additionalReturnValues | List<string> | [] | 0 ~ 10 items | Additional return values obtained with OpenId Connect |
ScopeValue
Scope value
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| key | string | ✓ | ~ 64 chars | Name | ||
| value | string | ~ 51200 chars | Value |
PlatformUser
Platform user information
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| type | int | ✓ | 0 ~ 1024 | Slot Number | ||
| userIdentifier | string | ✓ | ~ 1024 chars | User ID on various platforms | ||
| userId | string | ✓ | ~ 128 chars | User Id |