Master Data Reference of GS2-Account
{
"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"
]
}
}
]
}
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | ✓ | 2024-07-30 | Format version of master data | |||
| takeOverTypeModels | List<TakeOverTypeModel> | ~ 1000 items | 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. |
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 | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| configurationPath | string | ✓ | ~ 1024 chars | OpenID Connect Configuration URL | ||
| clientId | string | ✓ | ~ 1024 chars | Client ID | ||
| clientSecret | string | {configurationPath} != “https://appleid.apple.com/.well-known/openid-configuration” | ✓* | ~ 1024 chars | Client Secret * configurationPath is required for all IdP integrations other than “https://appleid.apple.com/.well-known/openid-configuration” | |
| appleTeamId | string | {configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration” | ✓* | ~ 1024 chars | Team ID of Apple Developer * Enabled if configurationPath is “https://appleid.apple.com/.well-known/openid-configuration” | |
| appleKeyId | string | {configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration” | ✓* | ~ 1024 chars | Key ID registered with Apple * Enabled if configurationPath is “https://appleid.apple.com/.well-known/openid-configuration” | |
| applePrivateKeyPem | string | {configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration” | ✓* | ~ 10240 chars | Private Key received from Apple * Enabled if configurationPath is “https://appleid.apple.com/.well-known/openid-configuration” | |
| doneEndpointUrl | string | ~ 1024 chars | URL to transition to when authentication is complete If not specified, it will transition to /authorization/done. id_token is attached to the Query String. | |||
| 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 | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| key | string | ✓ | ~ 64 chars | Name | ||
| value | string | ~ 51200 chars | Value |
PlatformUser
Platform user information
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| type | int | ✓ | 0 ~ 1024 | Slot Number | ||
| userIdentifier | string | ✓ | ~ 1024 chars | User ID on various platforms | ||
| userId | string | ✓ | ~ 128 chars | User 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.
| Type | Condition | Required | Default | Value Limits | 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 |