Skip to main content

LI PASS Web Configuration

Initialization ParametersTypeDescriptionRemarks
envstringSDK environment, test means test environment
For more information, see Get Deployment Cluster Info
Required
gameIDnumberGame IDRequired
appIDstringApp ID, the ACCOUNT_APP_ID assigned by the Player Network ConsoleRequired
WebIDstringWeb ID, the Web ID assigned by the Player Network ConsoleOptional
configobjectAdvanced ConfigurationOptional

config

note

如果您已在 Player Network 控制台创建 LI PASS Web 的配置,只需在控制台选择配置即可,无需手动配置 config 中的大部分参数。Player Network 控制台下发的配置优先级高于 config

The following configurations are not supported in the Player Network Console:

  • langType - Not supported for configuration. You may pass it during initialization as needed.
  • crossGameLink - No configuration needed, automatically provided
Parameter Type Description Note
isMobile boolean Whether to display the mobile interface Optional
Default: false (shows PC interface)

If you want to determine the device environment and dynamically set isMobile, configure Web Layout as Custom Configuration in the Player Network Console
socialList string[] Supported third-party login channels list
e.g. facebook, twitter, google, apple, line, steam, epic, ps5, discord, vk, twitch, qq, wechat
Optional
Default: []
socialParams object Additional configuration for third-party login channels Required for Apple and Kakao v3 channels
Default: {}
renderMode string Display mode
inline: Normal mode
modal: Modal mode
Optional
Default: inline
loginWithCode object Verification code login configuration Optional
Default: { enable: true, registerType: 'manual'}
loginWithPwd object Password login configuration Optional
Default: { enable: true, registerType: 'manual'}
procedureSwitch object Procedure switches Optional
Default: { region: false, adultStatus: false, agreement: false, registerPassword: 'onDemand'}
serviceIntro boolean Whether to enable LI PASS service introduction entry Optional
Default: false
langType string Default language. See Language List Optional
Default: en

Cannot be configured in Player Network Console
crossGameLink boolean Whether to enable cross-game account linking Optional
Default: false

No configuration needed, automatically delivered

socialParams

ParameterTypeDescriptionRemarks
appleAppIdstringApple channel Web app IDApple channel required
platformnumberSpecify the Garena login method
1: Garena
3: Facebook
8: Google
10: Apple
11: Twitter
Garena channel optional
kakaov3AppIdstringKakao app IDKakao v3 channel required
kakaov3JsKeystringKakao Javascript keyKakao v3 channel required

loginWithCode

ParameterTypeDescriptionRemarksDefault
enablebooleanEnable verification code loginOptionaltrue
registerTypestringRegistration type
manual: Only allow users to register manually
auto: Unregistered users can automatically register through verification code login
disabled: Disable registration, only allow existing users to log in
Optionalmanual

loginWithPwd

ParameterTypeDescriptionRemarksDefault
enablebooleanEnable password loginOptionaltrue
registerTypestringRegistration type
manual: Only allow users to register manually
disabled: Disable registration, only allow existing users to log in
Optionalmanual

procedureSwitch

arameter Type Description Remarks
region boolean Region switch, affects display of adultStatus and agreement

false: Region is not required during registration; registration does not check user region info during login
true: Region is required during registration; during login, the system will check if region info is filled, and will prompt for completion if not
Optional
Default: false
adultStatus boolean Adult status switch, depends on the region setting; enabling only this has no effect

false: No need to enter birthday or confirm adult clause during registration; login does not check user adult status info.
true: According to the user's selected region, require entry of birthday or confirmation of adult clause during registration; login will check if adult status info is filled, and will prompt for completion if not.In regions where compliance certification is not required, related content will not be displayed.
Optional
Default: false
agreement boolean Agreement clause switch, depends on the region setting

Basic Agreement Clauses: Terms of Service [required], Privacy Policy [required], Marketing Email Subscription [optional]
Regional Agreement Clauses: Data Transfer Notice [required] (EEA/Switzerland, except UK), Nighttime Marketing Email Subscription [optional] (Korea only)

false: No agreement clauses displayed during registration; login does not check agreement clause selection.
true, region=true: All agreement clauses are displayed during registration according to user's selected region; the system will check agreement clause selection during login.If required clauses are not selected, the system will prompt for completion; optional clauses may only be selected once per website.
true, region=false: Only basic agreement clauses are displayed during registration; only basic agreement clause selection is checked during login.If required clauses are not selected, system will prompt for selection.
Optional
Default: false
unrestrictedRegion string[] Removes restrictions for specified regions
Array of three-digit region codes, e.g. ['356']
Optional
Default: []

Not supported for configuration in Player Network Console
registerPassword string Three states for password settings, affects loginWithPwd workflow
When logging in with password, if the user has not set a password, a popup will guide the user to set a password or use verification code login.

disabled: No password setting required during registration; registration flow skips password setup page.
required: Password must be set during registration; user cannot skip.
onDemand: User can choose to set password during registration as needed.
Optional
Default: onDemand