Skip to main content

Type Definitions

Common Parameters​

Access source​

SourceSource
Client0
Server1
Midas2
Central Control8
Third-Party Channels9
Web11
WeChat Community16
Authorization Module17
Game Event Platform18
Auth Module20
Custom Account21
Customer Service System22
Data Management & Compliance System (DMCS)23
Survey Platform24
GameConfigS25
Player Network26
Player Network Console27
Login Launcher Console28
Account Deletion Service29
Game Event CGI30
Web Caller of Account Deletion Service31
JSSDK32
Security Component Server33
Player Network Console Internal Tool34
Player Network Community Backend35
Secure Access Sanitization36
GameNative Client37
SmartLink38
Player Network SDK Configuration Distribution API39
Garena Backend40

Channel Information Description​

Apple​

ParametersTypeDescriptionNote
codestringAn authorization code that can be used to obtain an access tokenRequired
user_namestringChannel Returns UsernameOptional
app_idstringApp ID for the Apple distribution channel—required when using multi-channel packagesOptional

Discord​

ParametersTypeDescriptionNote
access_tokenstringWeb User Access TokenRequired
refresh_tokenstringRefresh TokenRequired
expires_inuintTime remaining before the access token expires:
units (seconds)
Required
redirect_uristringRedirect URIOptional

Epic​

ParametersTypeDescriptionNote
openidstringPlayer Network SDK user unique identifier; this is the "account_id" parameter returned by the thirdAuthorize interface at, which is the `` parameter.Required
nicknamestringUser nickname for display purposesOptional
access_tokenstringWeb User Access TokenRequired
refresh_tokenstringRefresh TokenOptional
expires_inuintTime remaining before the access token expires:
units (seconds)
Optional
refresh_expires_inuintTime remaining until the refresh token expires:
units (seconds)
Optional

Facebook​

ParametersTypeDescriptionNote
access_tokenstringWeb User Access TokenRequired

Facebook Instant Game​

ParametersTypeDescriptionNote
signaturestringFacebook Instant Game SignatureRequired

Garena​

ParametersTypeDescriptionNote
tokenstringAccess token for Garena web users; the parameter returned by the thirdAuthorize interface is token Player Network SDK: Authorization is required
garena_sns_openidstringGarena OpenID: Parameters returned by the thirdAuthorize interface: garena_sns_openid Garena account linking is required
garena_sns_tokenstringGarena token, a parameter returned by the thirdAuthorize API: garena_sns_token Garena account linking is required

Google​

ParametersTypeDescriptionNote
codestringAn authorization code that can be used to obtain an access tokenRequired

Kakao v3​

ParametersTypeDescriptionNote
zatstringKakao v3 Access TokenRequired
picturestringProfile PictureOptional
playeridstringPlayer IDOptional
usernamestringUser IDOptional

LINE​

ParametersTypeDescriptionNote
access_tokenstringWeb User Access TokenRequired
expires_inint64Time remaining before the access token expires:
units (seconds)
Optional

PlayStation 5​

ParametersTypeDescriptionNote
codestringWeb User Access TokenRequired
redirect_uristringRedirect URIOptional

Steam​

ParametersTypeDescriptionNote
openid.nsstringSteam Web Login Protocol FieldsRequired
openid.modestringSteam Web Login Protocol FieldsRequired
openid.op_endpointstringSteam Web Login Protocol FieldsRequired
openid.claimed_idstringSteam Web Login Protocol FieldsRequired
openid.identitystringSteam Web Login Protocol FieldsRequired
openid.return_tostringSteam Web Login Protocol FieldsRequired
openid.response_noncestringSteam Web Login Protocol FieldsRequired
openid.assoc_handlestringSteam Web Login Protocol FieldsRequired
openid.signedstringSteam Web Login Protocol FieldsRequired
openid.sigstringSteam Web Login Protocol FieldsRequired

Twitch​

ParametersTypeDescriptionNote
access_tokenstringWeb User Access TokenRequired
refresh_tokenstringRefresh TokenRequired
expires_inuintTime remaining before the access token expires:
units (seconds)
Required
token_typestringAccess token type
, such as "bearer"
Required

X​

ParametersTypeDescriptionNote
oauth_tokenstringThe web user's access token, which is the parameter returned by the thirdAuthorize interface: access_token Required
oauth_secretstringThe access key for web users is , and the thirdAuthorize parameter returned by the interface is secret. Required

VK​

ParametersTypeDescriptionNote
tokenstringThe web user's access token, which is the parameter returned by the thirdAuthorize interface: access_token Required

Xbox​

ParametersTypeDescriptionNote
auth_tokenstringThe web user's access token, which is the "auth_token" parameter returned by the thirdAuthorize interface. ``Required
xuidstringThe Xbox UID of the web user is thirdAuthorize . The parameter returned by the interface is xuid. Required

QQ​

ParametersTypeDescriptionNote
access_tokenstringThe web user's access token, which is the parameter returned by the thirdAuthorize interface: access_token Required
refresh_tokenstringThe web user's refresh token is the parameter returned by the thirdAuthorize interface: refresh_token Required
expires_instringThe expiration time for web user information is thirdAuthorize , as specified by the parameter `` in the response from theexpires_inendpoint.Required
openidstringWeb user's QQ openid: ; thirdAuthorize: ; parameters returned by the API: ; openid Required

WeChat​

ParametersTypeDescriptionNote
codestringThe web user's access token, which is the "code" parameter returned by the ``thirdAuthorize endpoint. code Required

LI PASS​

ParametersTypeDescriptionNote
tokenstringSelf-hosted account, user authorization tokenRequired
openidstringUID of self-managed accountRequired
account_plat_typenumberThe account platform type
assigned by the Player Network console to distinguish between different self-hosted account platforms, with LI PASS set to 131.
Required
accountstringUser account, such as an email addressRequired