GS2-Account API Reference

This service provides account management functions to identify users. It supports data transfer using an email address + password or a social account, so that players keep their data when they replace or lose a device.

Anonymous accounts

GS2-Account issues anonymous accounts. Like an ordinary account it has a login ID and a password, but the distinguishing point is that the system generates both at random and never asks the player to enter them. The issued credentials are stored in the local storage of the device, and from the second launch onward the game signs in with them and resumes.

Players can start playing without going through a registration flow, and the game does not have to hold personal information.

Takeover

If the credentials are held only in the local storage of the device, the account is lost when the device breaks, is lost, or is replaced. To avoid this, a player can register takeover information at any time.

Takeover information records the user ID obtained by authenticating with a platform ID provider or a social account. On a new device, the player signs in to the same ID provider and runs the takeover with the user ID obtained there, which returns the credentials of the original anonymous account. Those credentials are stored in local storage again and used for subsequent sign-ins.

Takeover information is managed by slot numbers in the range 0 to 1024, so up to 1,025 entries can be registered. A different authentication method can be assigned to each slot, which also lets the game offer players a choice of takeover methods.

OpenID Connect integration

An authentication system compliant with OpenID Connect can be used to register takeover information and to run the takeover. The provider is configured per slot in the master data with the URL of the Discovery endpoint, the client ID and the client secret. For Sign in with Apple, specify the Team ID, the Key ID and the private key (PEM) instead of the client secret.

On a slot configured for OpenID Connect integration, registering takeover information and running the takeover with an arbitrary user identifier and password are no longer available.