Типы ответов

Типы ответов для регистрации, авторизации, сессий, соцпрофилей и игровых аккаунтов.

Типы ответов

LoginResult

Результат авторизации:

Поле	Тип	Описание
user	User	Данные пользователя
sessionId	String	ID сессии
sessionEnd	DateTime	Время истечения сессии
twoFactorChallenge	TwoFactorChallenge	Одноразовый запрос двухфакторного подтверждения, если сессия ещё не создана
message	String	Сообщение

TwoFactorChallenge

Поле	Тип	Описание
token	String!	Непрозрачный одноразовый токен запроса
availableMethods	[String!]!	Доступные способы: totp, email, recovery_code
expiresAt	DateTime!	Время окончания действия
provisioningUri	String	URI для подключения TOTP, только при настройке
manualKey	String	Ручной TOTP-ключ, только при настройке

GameAccountResult

Результат операции с игровым аккаунтом:

Поле	Тип	Описание
account	GameAccount!	Данные аккаунта
message	String	Сообщение

GameAccount

Игровой аккаунт (федеративный тип):

Поле	Тип	Сервис	Описание
id	ID!	User + Game	ID аккаунта
login	String!	User + Game	Логин
serverId	Int!	User + Game	ID сервера
hidden	Boolean!	User + Game	Скрыт ли аккаунт
status	GameAccountStatus!	Game	Статус (ACTIVE, HIDDEN, ...)
isBanned	Boolean!	Game	Забанен ли
characters	[Character!]!	Game	Персонажи
createdAt	DateTime	User + Game	Дата создания

OperationResult

Простой результат:

Поле	Тип	Описание
message	String!	Сообщение результата

UserResult

Результат операции с пользователем:

Поле	Тип	Описание
user	User!	Обновленные данные пользователя
message	String	Сообщение

Session

Сессия пользователя:

Поле	Тип	Описание
id	ID!	Идентификатор сессии для управления
isCurrent	Boolean!	Текущая ли сессия
expiresAt	DateTime	Время истечения

SocialProfile

Привязанная соцсеть:

Поле	Тип	Описание
id	ID!	ID записи
provider	String!	Провайдер (vkontakte, google, facebook, и др.)
identity	String!	Идентификатор в соцсети
nickname	String	Никнейм
createdAt	DateTime	Дата привязки

SocialProfileResult

Результат привязки соцсети:

Поле	Тип	Описание
profile	SocialProfile!	Данные профиля
message	String	Сообщение

SocialAuthUrl

Данные для перехода к внешнему провайдеру авторизации:

Поле	Тип	Описание
url	String!	URL перенаправления к провайдеру
provider	String!	Код провайдера, настроенного в проекте

ProjectSettings

Настройки проекта:

Поле	Тип	Описание
registrationEnabled	Boolean!	Регистрация включена
emailConfirmationRequired	Boolean!	Требуется подтверждение email
pinShieldEnabled	Boolean!	PIN-щит доступен
twoFactorAvailable	Boolean!	2FA доступна
socialLoginEnabled	Boolean!	Вход через соцсети включен
gameAccountLoginEnabled	Boolean!	Вход через игровой аккаунт включен

GameServer

Игровой сервер:

Поле	Тип	Описание
id	Int!	ID сервера
name	String!	Название
healthStatus	GameServerHealthStatus!	Текущее состояние подключения: UNKNOWN, AVAILABLE или UNAVAILABLE

GameCredentials

Данные для входа в игру:

Поле	Тип	Описание
login	String!	Логин
password	String!	Пароль
serverId	Int!	ID сервера

AccountLink

Связь с другой учетной записью:

Поле	Тип	Описание
id	ID!	ID связи
targetId	ID!	ID второй учетной записи
email	String	Email второй учетной записи
status	AccountLinkStatus!	PENDING, CONFIRMED или REVOKED
createdAt	DateTime	Дата создания
confirmationExpiresAt	DateTime	Срок действия кода подтверждения