@xmobitea/gn-server/apiReferences/Authenticate.json

GearN Server by XmobiTea (Pro)

{"requestType":"Authenticate","operations":[{"operationCode":"LoginByAccount","details":[{"role":"Client","requestData":[{"code":"Username","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":32}},{"code":"Password","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":64}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["AccountNotFound","AccountPasswordWrong","Ok"]},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByAndroidDeviceId","details":[{"role":"Client","requestData":[{"code":"AndroidDeviceId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":64}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByApple","details":[{"role":"Client","requestData":[{"code":"Token","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":32,"maxLength":2048}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["VerifyTokenError","AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByCustomDeviceId","details":[{"role":"Client","requestData":[{"code":"CustomDeviceId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":64}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByCustomId","details":[{"role":"Client","requestData":[{"code":"CustomId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":64}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByEditorDeviceId","details":[{"role":"Client","requestData":[{"code":"EditorDeviceId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":64}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByFacebook","details":[{"role":"Client","requestData":[{"code":"Token","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":32,"maxLength":2048}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["VerifyTokenError","AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByGameCenter","details":[{"role":"Client","requestData":[{"code":"PlayerId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":64}},{"code":"Name","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":128}},{"code":"PublicKeyUrl","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":2048}},{"code":"Signature","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":2048}},{"code":"Salt","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":256}},{"code":"Timestamp","description":"","optional":false,"type":"number","gnType":"Number","conditions":{}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["VerifyTokenError","AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByGenericService","details":[{"role":"Client","requestData":[{"code":"ServiceName","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":32}},{"code":"ServiceData","description":"","optional":false,"type":"GNHashtable","gnType":"GNHashtable","conditions":{"mustNonNull":true}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["VerifyFailed","AccountNotFound","Ok"]},{"code":"ErrorMessage"},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByGooglePlayGameService","details":[{"role":"Client","requestData":[{"code":"Token","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":32,"maxLength":2048}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["VerifyTokenError","AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByGoogle","details":[{"role":"Client","requestData":[{"code":"Token","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":32,"maxLength":2048}},{"code":"Type","description":"","optional":false,"type":"number","gnType":"Number","conditions":{"mustInt":true,"minValue":1,"maxValue":2}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["VerifyTokenError","AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByiOSDeviceId","details":[{"role":"Client","requestData":[{"code":"iOSDeviceId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":64}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByLinuxDeviceId","details":[{"role":"Client","requestData":[{"code":"LinuxDeviceId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":64}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByMacOSDeviceId","details":[{"role":"Client","requestData":[{"code":"MacOSDeviceId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":64}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByWindowsDeviceId","details":[{"role":"Client","requestData":[{"code":"WindowsDeviceId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":64}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"LoginByWindowsPhoneDeviceId","details":[{"role":"Client","requestData":[{"code":"WindowsPhoneDeviceId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":64}},{"code":"CreatePlayerIfNotExists","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["AccountNotFound","Ok"]},{"code":"NewlyCreated"},{"code":"UserId"},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"RefreshAuthToken","details":[],"responseData":[{"code":"ErrorCode","value":["AccountNotFound","PlayerBan","Ok"]},{"code":"PlayerBan"},{"code":"AuthToken"}],"description":""},{"operationCode":"RegisterAccount","details":[{"role":"Client","requestData":[{"code":"Username","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":32}},{"code":"Password","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":64}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["AccountUsernameExists","Ok"]},{"code":"UserId"},{"code":"InfoResponseParameters"},{"code":"NewlyCreated"}],"description":""}],"models":[{"name":"InfoRequestParam","details":[{"code":"External","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"Segments","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"CustomDatas","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"DisplayName","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"Avatar","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"TsCreate","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"Tags","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"PlayerBan","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"PlayerCurrencies","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"PlayerStatistics","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"PlayerDatas","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"IpAddressCreate","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"CountryCode","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"Email","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"TsLastLogin","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"PushNotifications","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"PlayerDataKeys","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"PlayerCurrencyKeys","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"PlayerStatisticsKeys","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"CustomDataKeys","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"TagKeys","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{"mustNonNull":false,"mustInt":false}}]}]}