Customer Identity (CIAM)
QQ Login
During the QQ login API call, different results are returned based on the configuration. A successful normal call returns the user's session_token; if the account is not bound or secondary authentication is enabled, it returns a state_token; failure returns error information.
# Request Description
POST https://{your_domain}/api/v2/sdk/login/qq
# Request Headers
| Parameter Name | Chinese Name | Required | Type | Example |
|---|---|---|---|---|
| X-operating-sys-version | Calling Client OS Version | Yes | String | windows10.1.1 |
| X-device-fingerprint | Calling Client Device Fingerprint | Yes | String | 156aysdna213sc50 |
| X-device-ip | Calling Client IP | No | String | 192.168.1.2 |
| X-agent | User-Agent Information | Yes | String | Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X) |
| X-L | For Internationalization Language Setting | No | String | zh |
| X-client-id | Application Authorization ID | Yes | String | nTo1eRIub60vPb54WeE6aojPwYwImtl4 |
| content-type | Content Format Type | Yes | String | application/json |
# Request Example {/examples/}
{
"access_token":"8B11C37B7894C5E2347E1606DC7CCFDC",
"open_id": "D8924F7071DC1D29A6822C794D848D9C"
}
1
2
3
4
2
3
4
# Request Parameters {/examples/}
| Parameter Name | Chinese Name | Required | Type | Description |
|---|---|---|---|---|
| access_token | QQ Authorization Token | Yes | String | QQ Authorization Token |
| open_id | QQ User Identifier ID | Yes | String | QQ User Identifier ID |
# Response Example {/examples/}
Success Example 1 (Returns session_token upon successful user match):
HTTP/1.1 200 OK
Content-Type: application/json
{
"session_token": "btsiBjx85prcZu6I6Ki057Tmw3nSF2VO",
"expire": 604800,
"status": "SUCCESS",
"id_token": "eyJraWQiOiJrMSIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJJc3N1ZXIiLCJhdWQiOiJBdWRpZW5jZSIsImV4cCI6MTY1MzQ4NDQxMiwianRpIjoieUxSVGZXY1VkYk9PeUFpbHdZU0ZqZyIsImlhdCI6MTY1MzQ2NjQxMiwibmJmIjoxNjUzNDY2MjkyLCJzdWIiOiJzdWJqZWN0IiwiYXBpIjoie1wibmFtZVwiOlwiXCIsXCJtb2JpbGVcIjpcIis4Ni0xNTkwNzEzMjg1MlwiLFwiaWRcIjpcIjIwMjIwNDI1MTQwMTM4NTE5LUJGMUItNTI4QjA1NTFCXCIsXCJ1c2VyTmFtZVwiOlwibG91eGlcIixcImVtYWlsXCI6XCIxMUBxcS5jb21cIn0ifQ.al79knH1fKa4aT4AFr_FMjqBKu2pV_g-lKzzgHzmor5X-dHwSBUtjH38KOzjIqHvkcRMjXQuBnWmjRI7-0Djn2LuWVueaf3wRXLscCWiSDC7chjUyTRXMatYINxdvW-oSWFYGFqqbdsavLqOnvehd7ahEaTuiL9yZolvslZIkIxjxBJJu7A9Ln2sk3wf9pxXU83jIJ8ubPQBoVS-ilerTTJOKDZ9XsL2ftJsaqdTJK_mYbvKaVpLIVyHHJ2NcF6f-Al4N4kc8cgxtSgSKFDcR7Bz7dYlOcfUXCPAzJ3NZInm8UaksiWU02tvlvTRvRdoxZNnvD5vamZ5hjFc-cW5jA"
}
Success Example 2 (Returns auto-register and bind flow):
HTTP/1.1 200 OK
Content-Type: application/json
{
"state_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ7XCJzb2NpYWxVaWRcIjpcIm8zRHVFNVNySXVodTlIZHFucHd0c3Y5a2dkSFFcIixcInN0YXR1c1wiOlwiVVNFUl9SRUdJU1RFUlwifSIsImV4cCI6MTY0NjcwNTcwNCwiaWF0IjoxNjQ2NzAzOTA0LCJqdGkiOiIxNjQ2NzAzOTA0NTEwMCJ9.tLEpS-9jrXwiJI3GlZw4RGg_z0zMDzKMMZtPBv2VPS8",
"data": "{\"socialBindOrRegisterFlow\":[\"VERIFY_PHONE\",\"VERIFY_EMAIL\"]}",
"status": "USER_REGISTER"
}
Success Example 3 (Returns bind flow):
HTTP/1.1 200 OK
Content-Type: application/json
{
"state_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ7XCJzb2NpYWxVaWRcIjpcIm8zRHVFNVNySXVodTlIZHFucHd0c3Y5a2dkSFFcIixcInN0YXR1c1wiOlwiVVNFUl9SRUdJU1RFUlwifSIsImV4cCI6MTY0NjcwNTcwNCwiaWF0IjoxNjQ2NzAzOTA0LCJqdGkiOiIxNjQ2NzAzOTA0NTEwMCJ9.tLEpS-9jrXwiJI3GlZw4RGg_z0zMDzKMMZtPBv2VPS8",
"data": "{\"socialBindOrRegisterFlow\":[\"VERIFY_PHONE\",\"VERIFY_EMAIL\"]}",
"status": " SOCIAL_BIND"
}
Success Example 4 (Returns secondary authentication flow):
HTTP 200 OK
{
"status": "MFA_AUTH",
"state_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ7XCJ1c2VySWRcIjpcIjIwMjIwMTIwMDk0MzEwNDM0LTg0N0MtQTFEOUJGOUIwXCIsXCJzdGF0dXNcIjpcIk1GQV9BVVRIXCJ9IiwiZXhwIjoxNjQ0MzkyNTEyLCJpYXQiOjE2NDQzOTA3MTIsImp0aSI6IjE2NDQzOTA3MTI2MDEwIn0.PcwlKPlPgIwnPZUE_s56_x5zB8YKaivfkpT0Fm5D2vU",
"data": "[\"SMS\"]"
}
Success Example 5 (Returns login denial flow):
HTTP 200 OK
{
"status": "ACCESS_DENIED",
"data": "拒绝访问"
}
Error Example:
HTTP/1.1 400 Bad Request
{
"error_code": "IDAAS.SDK.PARAM.0001",
"error_msg": "Device information is incomplete"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# Return Parameters
| Parameter Name | Chinese Name | Type | Description |
|---|---|---|---|
| status | Login Process Status Identifier | String | Possible values for this field are: SUCCESS Login Successful SOCIAL_BIND Binding Process USER_REGISTER Automatic Registration Binding Process ACCESS_DENIED Access Denied MFA_AUTH Login Successful but Requires Secondary Authentication |
| expire | session_token Validity Period | Number | session_token validity period, within which session_token can be used to obtain a ticket |
| session_token | User session_token | String | User session_token, which can be used to call IDaas interfaces to obtain a ticket; the ticket can be exchanged for user information |
| state_token | User Stateful Token | String | User Stateful Token |
| data | Return Description | String | Configuration information for the tenant's social registration and binding process. The content of the socialBindOrRegisterFlow field indicates the verification methods supported by the tenant.VERIFY_PHONE: Phone Number + SMS Verification Code VERIFY_EMAIL: Email + Email Verification Code |
| id_token | Short-term Valid, Interface Call Credential | String | This field is a JWT containing user information and the application's scope information. It needs to be verified and decoded to retrieve. It is valid for 2 hours by default and supports configuration. |
# Error Codes
| Status Code | Error Code | Error Message | Action |
|---|---|---|---|
| 400 | IDAAS.SDK.PARAM.0001 | Device information is incomplete | Please check if the input device information is complete |
| 设备信息不完整 | |||
| 400 | IDAAS.SDK.PARAM.0002 | clientId cannot be empty | Please check if the input clientId is empty |
| clientId不能为空 | |||
| 400 | IDAAS.SDK.PARAM.0003 | The app is not registered, please register the app first | Please check if the input clientId is correct |
| 应用未注册,请先注册应用 | |||
| 400 | IDAAS.SDK.PARAM.0024 | QQ access token cannot be empty | Please check if the QQ authorization token is empty |
| QQ授权令牌不能为空 | |||
| 400 | IDAAS.SDK.PARAM.0025 | QQ open ID cannot be empty | Please check if the QQ user identifier ID is empty |
| QQ用户标识ID不能为空 | |||
| 400 | IDAAS.SDK.USER.0001 | User not found | Please register and try again |
| 用户未找到 | |||
| 400 | IDAAS.SDK.USER.0039 | User is disabled | Please contact the administrator |
| 用户已被禁用 | |||
| 500 | IDAAS.SDK.COM.0002 | System busy, please try again later | Please retry or contact Zhuyun staff |
| 系统繁忙,请稍后再试 |
