Type Definitions
Common Parameters
Access source
| Source | Source |
|---|---|
| Client | 0 |
| Server | 1 |
| Midas | 2 |
| Central Control | 8 |
| Third-Party Channels | 9 |
| Web | 11 |
| WeChat Community | 16 |
| Authorization Module | 17 |
| Game Event Platform | 18 |
| Auth Module | 20 |
| Custom Account | 21 |
| Customer Service System | 22 |
| Data Management & Compliance System (DMCS) | 23 |
| Survey Platform | 24 |
| GameConfigS | 25 |
| Player Network | 26 |
| Player Network Console | 27 |
| Login Launcher Console | 28 |
| Account Deletion Service | 29 |
| Game Event CGI | 30 |
| Web Caller of Account Deletion Service | 31 |
| JSSDK | 32 |
| Security Component Server | 33 |
| Player Network Console Internal Tool | 34 |
| Player Network Community Backend | 35 |
| Secure Access Sanitization | 36 |
| GameNative Client | 37 |
| SmartLink | 38 |
| Player Network SDK Configuration Distribution API | 39 |
| Garena Backend | 40 |
Channel Information Description
Apple
| Parameters | Type | Description | Note |
|---|---|---|---|
| code | string | An authorization code that can be used to obtain an access token | Required |
| user_name | string | Channel Returns Username | Optional |
| app_id | string | App ID for the Apple distribution channel—required when using multi-channel packages | Optional |
Discord
| Parameters | Type | Description | Note |
|---|---|---|---|
| access_token | string | Web User Access Token | Required |
| refresh_token | string | Refresh Token | Required |
| expires_in | uint | Time remaining before the access token expires: units (seconds) | Required |
| redirect_uri | string | Redirect URI | Optional |
Epic
| Parameters | Type | Description | Note |
|---|---|---|---|
| openid | string | Player Network SDK user unique identifier; this is the "account_id" parameter returned by the thirdAuthorize interface at, which is the `` parameter. | Required |
| nickname | string | User nickname for display purposes | Optional |
| access_token | string | Web User Access Token | Required |
| refresh_token | string | Refresh Token | Optional |
| expires_in | uint | Time remaining before the access token expires: units (seconds) | Optional |
| refresh_expires_in | uint | Time remaining until the refresh token expires: units (seconds) | Optional |
Facebook
| Parameters | Type | Description | Note |
|---|---|---|---|
| access_token | string | Web User Access Token | Required |
Facebook Instant Game
| Parameters | Type | Description | Note |
|---|---|---|---|
| signature | string | Facebook Instant Game Signature | Required |
Garena
| Parameters | Type | Description | Note |
|---|---|---|---|
| token | string | Access token for Garena web users; the parameter returned by the thirdAuthorize interface is token | Player Network SDK: Authorization is required |
| garena_sns_openid | string | Garena OpenID: Parameters returned by the thirdAuthorize interface: garena_sns_openid | Garena account linking is required |
| garena_sns_token | string | Garena token, a parameter returned by the thirdAuthorize API: garena_sns_token | Garena account linking is required |
Google
| Parameters | Type | Description | Note |
|---|---|---|---|
| code | string | An authorization code that can be used to obtain an access token | Required |
Kakao v3
| Parameters | Type | Description | Note |
|---|---|---|---|
| zat | string | Kakao v3 Access Token | Required |
| picture | string | Profile Picture | Optional |
| playerid | string | Player ID | Optional |
| username | string | User ID | Optional |
LINE
| Parameters | Type | Description | Note |
|---|---|---|---|
| access_token | string | Web User Access Token | Required |
| expires_in | int64 | Time remaining before the access token expires: units (seconds) | Optional |
PlayStation 5
| Parameters | Type | Description | Note |
|---|---|---|---|
| code | string | Web User Access Token | Required |
| redirect_uri | string | Redirect URI | Optional |
Steam
| Parameters | Type | Description | Note |
|---|---|---|---|
| openid.ns | string | Steam Web Login Protocol Fields | Required |
| openid.mode | string | Steam Web Login Protocol Fields | Required |
| openid.op_endpoint | string | Steam Web Login Protocol Fields | Required |
| openid.claimed_id | string | Steam Web Login Protocol Fields | Required |
| openid.identity | string | Steam Web Login Protocol Fields | Required |
| openid.return_to | string | Steam Web Login Protocol Fields | Required |
| openid.response_nonce | string | Steam Web Login Protocol Fields | Required |
| openid.assoc_handle | string | Steam Web Login Protocol Fields | Required |
| openid.signed | string | Steam Web Login Protocol Fields | Required |
| openid.sig | string | Steam Web Login Protocol Fields | Required |
Twitch
| Parameters | Type | Description | Note |
|---|---|---|---|
| access_token | string | Web User Access Token | Required |
| refresh_token | string | Refresh Token | Required |
| expires_in | uint | Time remaining before the access token expires: units (seconds) | Required |
| token_type | string | Access token type , such as "bearer" | Required |
X
| Parameters | Type | Description | Note |
|---|---|---|---|
| oauth_token | string | The web user's access token, which is the parameter returned by the thirdAuthorize interface: access_token | Required |
| oauth_secret | string | The access key for web users is , and the thirdAuthorize parameter returned by the interface is secret. | Required |
VK
| Parameters | Type | Description | Note |
|---|---|---|---|
| token | string | The web user's access token, which is the parameter returned by the thirdAuthorize interface: access_token | Required |
Xbox
| Parameters | Type | Description | Note |
|---|---|---|---|
| auth_token | string | The web user's access token, which is the "auth_token" parameter returned by the thirdAuthorize interface. `` | Required |
| xuid | string | The Xbox UID of the web user is thirdAuthorize . The parameter returned by the interface is xuid. | Required |
QQ
| Parameters | Type | Description | Note |
|---|---|---|---|
| access_token | string | The web user's access token, which is the parameter returned by the thirdAuthorize interface: access_token | Required |
| refresh_token | string | The web user's refresh token is the parameter returned by the thirdAuthorize interface: refresh_token | Required |
| expires_in | string | The expiration time for web user information is thirdAuthorize , as specified by the parameter `` in the response from theexpires_inendpoint. | Required |
| openid | string | Web user's QQ openid: ; thirdAuthorize: ; parameters returned by the API: ; openid | Required |
WeChat
| Parameters | Type | Description | Note |
|---|---|---|---|
| code | string | The web user's access token, which is the "code" parameter returned by the ``thirdAuthorize endpoint. code | Required |
LI PASS
| Parameters | Type | Description | Note |
|---|---|---|---|
| token | string | Self-hosted account, user authorization token | Required |
| openid | string | UID of self-managed account | Required |
| account_plat_type | number | The account platform type assigned by the Player Network console to distinguish between different self-hosted account platforms, with LI PASS set to 131. | Required |
| account | string | User account, such as an email address | Required |