Response Types

Response types for registration, authentication, sessions, social profiles, and game accounts.

Response types

LoginResult

Authentication result:

Field	Type	Description
user	User	User data
sessionId	String	Session ID
sessionEnd	DateTime	Session expiration time
twoFactorChallenge	TwoFactorChallenge	One-time two-factor verification request when no session has been created yet
message	String	Message

TwoFactorChallenge

Field	Type	Description
token	String!	Opaque one-time request token
availableMethods	[String!]!	Available methods: totp, email, recovery_code
expiresAt	DateTime!	Expiration time
provisioningUri	String	TOTP enrollment URI, returned only during setup
manualKey	String	Manual TOTP key, returned only during setup

GameAccountResult

Game account operation result:

Field	Type	Description
account	GameAccount!	Account data
message	String	Message

GameAccount

Game account (federated type):

Field	Type	Service	Description
id	ID!	User + Game	Account ID
login	String!	User + Game	Login
serverId	Int!	User + Game	Server ID
hidden	Boolean!	User + Game	Whether account is hidden
status	GameAccountStatus!	Game	Status (ACTIVE, HIDDEN, ...)
isBanned	Boolean!	Game	Whether banned
characters	[Character!]!	Game	characters
createdAt	DateTime	User + Game	Creation date

OperationResult

Simple result:

Field	Type	Description
message	String!	Result message

UserResult

User operation result:

Field	Type	Description
user	User!	Updated user data
message	String	Message

Session

User session:

Field	Type	Description
id	ID!	Session management identifier
isCurrent	Boolean!	Whether this is the current session
expiresAt	DateTime	Expiration time

SocialProfile

Linked social network:

Field	Type	Description
id	ID!	Record ID
provider	String!	Provider (vkontakte, google, facebook, etc.)
identity	String!	Social network identifier
nickname	String	Nickname
createdAt	DateTime	Link date

SocialProfileResult

Social network linking result:

Field	Type	Description
profile	SocialProfile!	Profile data
message	String	Message

SocialAuthUrl

Redirect information for an external authentication provider:

Field	Type	Description
url	String!	Provider redirect URL
provider	String!	Provider code configured by the project

ProjectSettings

Project settings:

Field	Type	Description
registrationEnabled	Boolean!	Registration enabled
emailConfirmationRequired	Boolean!	Email confirmation required
pinShieldEnabled	Boolean!	PIN shield available
twoFactorAvailable	Boolean!	2FA available
socialLoginEnabled	Boolean!	Social network login enabled
gameAccountLoginEnabled	Boolean!	Game account login enabled

GameServer

Game server:

Field	Type	Description
id	Int!	Server ID
name	String!	Name
healthStatus	GameServerHealthStatus!	Current connection state: UNKNOWN, AVAILABLE, or UNAVAILABLE

GameCredentials

Game login credentials:

Field	Type	Description
login	String!	Login
password	String!	Password
serverId	Int!	Server ID

AccountLink

Linked account relationship:

Field	Type	Description
id	ID!	Link ID
targetId	ID!	Other account ID
email	String	Other account email
status	AccountLinkStatus!	PENDING, CONFIRMED, or REVOKED
createdAt	DateTime	Creation date
confirmationExpiresAt	DateTime	Confirmation code expiration