This document introduces CIAM account authentication APIs.
1. Token validity check
API description:
When calling the detection API above, ensure you include the corresponding type of token.
API endpoint:
Request URI: GET /api/bff/v1.2/developer/ciam/user/token/check
Request parameters:
Response parameters:
Token valid response parameters:
Parameter name | Type | Example | Description |
success | boolean | true | Request successful |
code | int | 200 | Event result code |
message | string | null | Event message |
requestId | string | 8D5CDDCF-C77A-4A0A-A8A6-16314E57847F | Unique event ID |
data | string | null | Log |
Token invalid response parameters:
Parameter name | Type | Example | Description |
error | string | invalid_token | Invalid |
error_description | int | Invalid access token: eyJhbGciOiJIU ... ... WJferRYl0 | Token invalid |
2. Account security
2.1. Operation check
This API returns fId and indicates whether Two-factor authentication (2FA) is required.
API endpoint
Request URI: GET /api/bff/v1.2/developer/ciam/user/operate_check
Request parameters
operateType=UPDATE_PASSWORDParameter name | Type | Required | Description |
operateType | string | Yes | Passed in URL, currently only supports:
|
Response parameters
2FA required
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655084314822$73399b3e-0239-0de0-6ac9-bf764400b851",
"data": {
"fId": "202206130938354797885760663934976_Y_03",
"flowType": "NEED_TWO_FACTOR",
"additional": null
}
}2FA not required
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655953376073$483cd2c7-eb28-e8b0-63f2-aefbaf5d55fc",
"data": {
"fId": "202206231102561313385674235612160_Y_3",
"flowType": "USER_UPDATE_PWD",
"additional": null
}
}Parameter name | Type | Required | Description |
flowType | string | Yes | Identifier for the next step in the flow, reference:
|
2.2. 2FA - Send verification code
Only used for 2FA with phone number or email verification code
API endpoint
Request URI: POST /api/bff/v1.2/developer/ciam/user/2fa/obtain_code
Content-Type: application/json
Request parameters
{
"fId":"{{fId}}",
"type":"SMS",
"captchaCode":"",
"captchaText":""
}Parameter name | Type | Required | Description |
fId | string | Yes | fId from the previous step |
type | string | Yes | 2FA method, (currently) available values: SMS, EMAIL, based on the selected 2FA method |
language | string | No | Language type for sending verification code, defaults to preferred language |
engineCode | string | No | Gateway code for sending verification code, defaults to preferred provider's preferred gateway |
captchaCode | string | No | CAPTCHA code, returned by the get verification code API, required when CAPTCHA exists |
captchaText | string | No | User-entered CAPTCHA text, required when CAPTCHA exists |
Response parameters
Unsupported 2FA method
{
"success": false,
"code": "Params.Illegal",
"message": "Operation.Failure.Unsupport.2fa.Type",
"requestId": "1654681888509$40033cb3-9d4f-4a52-e3a3-447c52c80fb1",
"data": null
}Normal
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655084624228$e190452c-b475-829f-eea3-e9ac46e37db0",
"data": {
"fId": "20220613094341108226886868558848_Y_03"
}
}2.3. 2FA - Verification code
Only used for 2FA with phone number or email verification code
API endpoint
Request URI: POST /api/bff/v1.2/developer/ciam/user/2fa/verify_code
Content-Type: application/json
Request parameters
{
"code":"000000",
"type":"SMS",
"fId":"{{fId}}"
}Parameter name | Type | Required | Description |
fId | string | Yes | fId from the previous step |
type | string | Yes | 2FA method, (currently) available values: SMS, EMAIL, PWD, based on the selected 2FA method |
code | string | Yes | Phone or email verification code |
Response parameters
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655953475289$f2bd04aa-5190-e998-4d3d-d1faaa2e60a4",
"data": {
"fId": "202206231104298465085851146237952_Y_03",
"flowType": "USER_UPDATE_PWD",
"additional": null
}
}2.4. 2FA - Verify password
API endpoint
Request URI: POST /api/bff/v1.2/developer/ciam/user/2fa/verify_code
Content-Type: application/json
Request parameters
{
"password":"966966",
"type":"PWD",
"fId":"{{fId}}"
}Parameter name | Type | Required | Description |
fId | string | Yes | fId from the previous step |
type | string | Yes | 2FA method, fixed as PWD |
password | string | Yes | User-entered password |
Response parameters
2FA failed
{
"success": false,
"code": "Operation.Failure",
"message": "Operation.Failure.User.Password.Error",
"requestId": "1654747792211$750c5b3e-5dd2-efa1-60a5-1acc88ca1f85",
"data": null
}Invalid 2FA method
{
"success": false,
"code": "Operation.Failure",
"message": "Operation.Failure.Unsupported.2fa.Type",
"requestId": "1655084909746$eb81b1c8-51a6-a7e6-3293-6adb78a786b3",
"data": null
}2FA successful
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655953475289$f2bd04aa-5190-e998-4d3d-d1faaa2e60a4",
"data": {
"fId": "202206231104298465085851146237952_Y_03",
"flowType": "USER_UPDATE_PWD",
"additional": null
}
}2.5. Change password
API endpoint
Request URI: PUT /api/bff/v1.2/developer/ciam/user/change_pwd
Content-Type: application/json
Request parameters
{
"newPassword":"966966",
"fId": "{{fId}}"
}Parameter name | Type | Required | Description |
fId | string | Yes | fId from the previous step, the preceding flow is 2.1 Operation check |
newPassword | string | Yes | User-entered new password |
Response parameters
Modification failed - same as old password
{
"success": false,
"code": "Operation.Failure",
"message": "Params.Illegal.User.Password.Same.Old",
"requestId": "1655085873136$dd1d23dc-5e2f-395e-311a-a375a2799e77",
"data": null
}Modification successful (data is null when successful)
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655085926945$3ac20c22-f35e-5582-3032-39928132f865",
"data": null
}2.6. Change phone/email - Send verification code
API endpoint
Request URI: POST /api/bff/v1.2/developer/ciam/user/change_phone_or_email/obtain_code
Content-Type: application/json
Request parameters
{
"fId": "{{fId}}",
"type":"EMAIL",
"email":"123******@gmail.com",
"phoneNumber":"",
"phoneRegion":""
}Parameter name | Type | Required | Description |
fId | string | Yes | fId from the previous step, the preceding flow is 2.1 Operation check |
type | string | Yes | Verification code type, corresponding to the field type being modified, available values: EMAIL (email) and SMS (phone number) |
string | No | Required when type=EMAIL | |
phoneNumber | string | No | Required when type=SMS |
phoneRegion | string | No | Optional when type=SMS |
language | string | No | Language type for sending verification code, defaults to preferred language |
engineCode | string | No | Gateway code for sending verification code, defaults to preferred provider's preferred gateway |
Response parameters
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655104132238$032d8302-306c-04c3-d301-f89db1a5c993",
"data": {
"fId": "202206131508431202892259157892096_Y_03"
}
}2.7. Change phone/email - Verification code
API endpoint
Request URI: POST /api/bff/v1.2/developer/ciam/user/change_phone_or_email/verify_code
Content-Type: application/json
Request parameters
{
"fId":"{{fId}}",
"type":"EMAIL",
"code":"000000"
}Parameter name | Type | Required | Description |
fId | string | Yes | fId from the previous step |
type | string | Yes | Verification code type, corresponding to the field type being modified, available values: EMAIL (email) and SMS (phone number) |
code | string | No | Phone number or email verification code, user input |
Response parameters
Modification successful data is null
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655104186558$e44d6012-cd7d-e6b0-3522-8d14be15ad8c",
"data": null
}2.8. Query social account binding information
API endpoint
Request URI: GET /api/bff/v1.2/developer/ciam/user/social_bind_info
Request parameters
None
Return parameters
The modification was successful but the data has no value.
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655282559705$578f2109-bd6c-1836-96c0-31ba3c42a6b6",
"data": [
{
"name": "WeChat Logon",
"enterpriseAuthId": "ciammasterwechat",
"logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAb0ElEQVR4Xu1dCZQdVZn+/uruWl4nbCIyLnMkCEGQTTYJioS8eg0EEBSCCuIoAurIUUQgiFFAjSAMLoALhhkGISNRQYIk9HsvCSBLhIiMgChbwEFGHCRo0q+W7lf/nNvdabrTb6t6tbx6de85OQn0/bfvr6/rVtW9/0+QQyIgEaiLAElsJAISgfoISILIq0Mi0AABSRB5eUgEJEHkNSARCIaAvIMEw01KZQQBSZCMJFqGGQwBSZBguEmpjCAgCZKRRMswgyEgCRIMNymVEQQkQTKSaBlmMAQkQYLhJqUygoAkSEYSLcMMhoAkSDDcpFRGEJAEyUiiZZjBEJAECYablMoIApIgGUm0DDMYApIgwXCTUhlBQBIkI4mWYQZDQBIkGG5SKiMISIJkJNEyzGAISIIEw01KZQQBSZCMJFqGGQwBSZBguEmpjCAgCZKRRMswgyGQSYLoZX2W4vFuTJjNjNlEmA2wASIDHnIgGKP/DTIA8W8MgVGBgiEGhoipAvAQET/nVfE8SHkOhOcwgufsI+3ngqVCSnUiAl1NkFwx90b0VPf2PN6boOzD4D0IggzoizIZzHiMiB5l9h5TQI95TI/aA/b6KG1K3dEg0FUEMQb7DmLQkdRDe4GxF4Cdo4EtgFamDSAUmVDy4D3g5t3fB9AiRWJGIPUEmSCFgiMAOihm/AKbI+AJj3E/KVy2LHc5jkElsDIpGBkCqSRI/519e1eJjqeUkaJuFhn/A8JtnoflzoBTiizbUrFvBFJDkJlrZm5fHRk+3gMfR8BRviNNj8Bv2ePlTHSTU3CeSo/b3elpxxMkV9SO8giCFMcD2L4701AzKpvASz1WltoFe1WG4u6oUDuWILmydjQDZ4BxTEchloAzBJQ90FLbtP8jAfOZNtlxBJHEaHQ98lpm5Xt2wf5xpq/aGIPvGILoZX0ugc+Wd4wWss9YDeJrLNO9pYXZckobCCRPkBXQcn36IgZf2EYcWRW9DVVvsXXE8INZBSDquBMlSK6kzWfmRaD0fL+IOiEB9NtMvNh+xV2MBagGkJciDRBIhiC3I2fo2tcAnC2zExoC9xFjcaXgrAhNo1SE2AnSX+zbxyPl2wDeK/GPAAHGldZ2zkLsj+EItGdOZawEMcrqSWAS5Ngxc0jHGTDjHijKQitvPRCn2W60FRtB9LK6iJgu6UYQOzImsT2fsNAynas60r+UOBULQYySeiNAJ6cEk65yk8A3VEz3o10VVIzBRE4Qo6wvA/OJMcYkTU1HYJVlOnkJjH8EIiWIXtJWEsQ2dDmSRkAc4rILzp5J+5E2+5ERxChpTwDYLW2AdLm/f7VM5w1dHmOo4UVCEKOkWQD0UD2VykJDwDKdSPIemoMdpCh0oIyytgGMbTooRunKlggwnrYKzi4SmOYIhEoQo6g9BcLbmpuVM5JGgAkr7bzTzQfPQoE4NIIYJfV+gA4OxSupJB4EiH5q5e0F8RhLp5VQCGKUtNsAHJtOCLLtNTOuswvOJ7KNQv3o2yZIrqhfwsSLJMDpRYCZL7QL7uL0RhCd520RRCtqBYUwGJ17UnNsCHj8IWvA/Uls9lJiKDhBRresq6vTVIsqJTlJys2XUfXmy8NXU+EPTBCjrF0BxjlJZRPASwDuBfAnAOvJw9NeD2+HKnYhUmZD4flgzEzQv0amHwboD8J3YjzjEZ4GMEsBZrF4C8gsnudETeBYhygOUTEdM1ajHW4sEEFyq7VjuQrxYJ7EsAFczQpdbc+zn6/nQK7Ytz+TcjmAw5Jwso7NZ4TvVq9zNeZipJ5fekk/jIi/M14+NV73CZ+z8s534jXaudYCEcQoaeI39yGxh8VYrii8aCjv/q5V20ZJfT9AP291flTz2OOL+3q0qzbmN/6tVRv6oHoRKfSVVueHNO8vnoJ3O/McQebMD98EMYrqeSC6LAHkHu211cM3HrPxZb+2c0V9MRNf4FcuvPm01DLtQNv9jbL2CBh7h+dLc03MWGIXnNObz+z+Gb4Ioq3WZise7gXHW+GQgb8TK/OtgnVfoJTcD8PYpD0MSmTz5L2W7QwELU5tFI1DQJ64Y8c6iPG+SsFZHqvRDjTmiyC5knodgz6eQByft0znW+3YNYrq+SC6tB0dgWRJmdPu0VejrC1PoF6YPEMCtF60YbRED/DLQBdJu0JhXGRF9UQQLWvXFX/y/Ipluq/zJzN9tlHWvg3GZ9vV41eemE6vFOwlfuW6aX7LdxCjpN8McBL7dizLdHLtgq6W1d17mB5vV48f+bA2BObK2qeZcY0f22HMHT1kxc67MIChMPSlUUdLBBFNaqAoaxMK8C7LdOaGYdsoaRyGnlZ1iDdX9oB7Uavz680bfe0LXtOuniDyWd+G0hpBytrVYPxrEIDbliFstPLOVu3qGX3BUIX4OBffINxu5Z22N3HmytqZzPhBfI5PsfSstcF5OxbATch+omabEkR0hCXmR4Dkvkor7O07VBgWPgQeCX3cfNEynTcFdnpc0Chp4oPnF9rVE1ieeYFVcH8aWD7Fgs0JkszHqimQEuiMimn/qB2cjZL2OQBtvQkLYr/H4z03DbiPBZHdLGOUtZ+CcUI7OtqSJbrJytuntKUjpcJNCZIra0VmJL0/5xF26Th7fv2tJc3wTywO4hutvPuRZv7V+7lYGlIVDxLQ9jIzqA+jfeJ7ld2sudYLbehIpWhDgsy8feb2I7r7fx0S2V2W7cwP8sHNKGmiSPaVCcZxtWU6ZwWxr5e0OwkYCCIbssxZlulcHbLOjlfXkCAJrdsbgXaLQnyx3IuVwHWV0eO5DQlilLTvAgj0my/CFMrdvBGCW1c14wVrhrMr5kCUdMrMaEyQzq5S8hLAZQYeAynrbNd+UFXVNytQDobHB5OCBZ18HoSBdSR897wHrYHhX+fKfQegqhwAhfdn0AeTOA/S7Kpnj+bZA/bqZvO66ed1CTJjcMYOVWVYHEqSQyIwigCDv2Sb7tezBEddguhFfR4Rl7MERiZiJbwAxnoCr/c8rCeFhogw5HlUIXhD1EtDXpUqCrifiWcwKYbCnGPAYHDOzrtfzQRO40HWJYhR1D4Lgmh2I0c6EagCvA6gB8jju6sePeFsdNZn9Yt40BTWv4OUtR8RQ9ZLCopsInL8a/Zwp6LQQ2qvc9+rc/FqIm50kdEGdxB1rew+m4ZMj5GCwCvFw37bHq+BPrM6s3+Yh/u9YW9Gr8r9Hvf0K1QdGnFpSOlTNvVR39DGno1DmAvxRrGrR32ClLRNAPq7Ovq0Bkd4FYwfw/NuCkIKbYW2c4/Ke7JHs0DYCcBORNiJGbN8VeUnWOzhWSKI8+vPiL8JeKZnxHnwH0fglbTCO9nvmgTZ+pfY1tW0rgiwG5I0EQPjaVb4BpByQ6OKLlvGbAwac6B4c0CYA8YcAHH0CBGbS+9i4nWs0DrncOePacxFTYJoK7XZSm/MW8PTiF5MPhPwezCuqmzn3ID9UWlmtr+s7uUxFQgwGSg0mx/Tz0cJI14YqKp7V1qej2oSRC/r7yHme2ICTpqphwCjQqB/U4fsK189vvEDt1E2Dga8k9jDPCK8o8NBfRUkyILBVkmfVDw1CWKU1A8A9LOknJJ2RbEAvoGqfOXQEcP/3QiPXFE7lgmnAvhAKnELuGyMK9aaBMmVtE8x8L24nJB2piDwCHl8cWXA/UUjXPSyfhp5fCoIh3YFfuMvHsjz/rMyMPybTomp9hKrAw5JdQpAMfvxba3XubjR+jxX1s9g4Aww7xezb7GZY+BaxfOu7QSi1FliaWIHr9jJK0c8CDS9a2SBGFtC3QlEqfcM8mGAborn2si2FVGMQe9zLqh318iVtaOZcT6Ad2cWKabLtD770iTefNV+zVvSBhTgzswmJKbAifGpSsGpWa1EH9R3AvH5RDgzJnc62gwzHodCl9p5+8Y4Ha39kD7WOuChOB3JnC1POcQasO6vFbdRGl3iirtG2xVRug9XulmB9/Uh0300jtjqPKTrO5HCz8bhQBZtWBucmVgAsZVn6lgGVd9Wu4rEQ7gc9RFgvEDEn6mYbuQ9amrvxVqBrYw+7e8yRxEgoChvtuZZf95Sszqo7tar0FUM5COw2q0q2y5q3gyYRpsVNwDYppkC+fPWEWDQXNu079pSIlfUjmLCVaINW+va5MxxBAJXjGkFwfoEKWu3gnFcK0rknBYQqFOd0Eik6nwL/qZoiigSro44p0Sxg7jRHSSRSoQpykvLrrLHp9gD7rTX5pIcLUPYfCKLJq44IuzWcQ3uIMbBYK/mW5bm3soZmxFg5i/bhennuPWS/nECXyeRChcBIu/ASn44tDew9cv+rEGvMaKJqoryOSRgDon5+krB/diW4npJvZBAXwuoVoo1QYAUb7/KvOGHwwCqWeE40VFqfhiGMqeDcY/FzlFbNp/JDWqfZiX+ZjhZw79KvIebd3/fbtwNCZJQG+J2Y+oE+VcV9uZu2bLBGFQ/CIX+qxMc7HofCMNV8D7tkqTxHSTZzlJpzuHZlulMKZk01qWLVgC0XZoDS5PvBDwxQnxCOyRp2v7AKKlrATooTcAk6ivhF1beOX6KD8sww9hGHQSROA8uR5wIiKXuq87hWIBqELNNCSKXWb5grbm00ova94nwSV+a5OTQECCixZW8fWEQhU0JknADzyAxJSkzbWmVK2qfZML3k3RK2gaIMb9ScFb4xaIpQYRCucxqAVai31h5e//JM8fL7QwCmNGCBjklWgQe1uEcvsGErz2GLRFELrOaZ46Izqzk7Wsnz9RL2h0EHNVcWs6IBQGiy6y8vdCPrZYIsm0JWzvQHmDg7X6UZ2ZurbtHSV0A0M0JYPAIAw8phEcIeJaBWQzsDA+7gHBMAv6I5U2JCY8z0W/I84aA0YqOOxOwS8y7l6sYO4fTconWlggiQM0N6mewwj9MAuBOt1nr7mEUtbvjrjhC4H9Xe91z6h1N1QY1s6cH58bZlJU9vtgecC+ql8PxLTfnAZgdS54ZP7MKzomt2mqZIGPPIproFzKvVeVZmMeMx+yCs+fUpVX8+6yaXYhTno3K2mVgiIsy0tGqT6JZbNVwl8ZHXD7ZMt2lrQTviyC5Qe1oVnB7K4qzMoeZL7QL7uIpF2BJfwjgKQ/sEePxK8t0fNXHMorabSAcG6FfvnwSBbWVXqwB4S0R+jSumtZZpn1AK3Z8EWTsLqLeAFDgvt+tOJWiOUPs0Z72gL1+s89GWT0JTD+JMYZN3gj2d470Vxx69ILsg6jaGH4Ff6YNXpUP9uuTUVSPB9EtsWBH/EEr7zZ9RvRNkP5i3z4eelaDeNtYAulgI0xYYued06fePbR4N3gy328V3EOCwGSU9AcBbuk3qT/9dLNl2qIRqa8x454Zr686w3/1JRR88h2W6RzdTNw3QcbuItpngNEjopkezJS3C/aqzSDoJf0wAq+JExRRV8suOJ8KYlMvakuIcFoQ2UYy7NEn7AE70FkXo6Q9CWCXsH2qpa/eEejJcwMRZIwk+s0AL4gjkE60UevhPFfWljCHf8E1vBglQQJfHkS4rpJ3GrYZDEwQbbU2W6lC9Mx+Y2APUyzIwA9sc9Jv7mXoMbbV/hQ7HnKJ1cZVxK/0Vd1dGp1lD0wQ4VWurJ/GzEva8DC1osz0EbvwWpU/fZV+qGgOk0BAwR7Sy9quCkOcuuuch/QE2m4w8Sl2fnq9gM15bIsgoyQpqtcz0UcTuDASNSn6+01+e6WX1C8RKKke4r5eqeI2zDRy2h0A3hMhiL58Eg2AmL2VBGwdoU81VPNNlumeUs9m2wQZA1stAvSueANL1Np6y3Sm1LAySuoDSWLQ6ke58aWx+G7z/qgRZPBFtule3MyO+MKvKKP9aN7WbG74P2+8zGqfIAC0sdv1rwDsEH4AHaiR6SdWwf7QhGf3YqZhaf/oAE/vQo+y0Dq89l4jo6ieB4XOBWP7uHwVnbI8KIts0xbPZ1OGcbfxFrie+KIv3oomOPgEy3R/XsuBUAgiFCfxijMxRInPt/LuNzfb14v6PCIW23A6ZfyKPV6t9NA6r8r7Uw+9EwzRcCeRFyoM/J0I9xBwJ3u8AQrtN+oPQfw9M2nQiOkblYL9xUgJIpQbRfVDIGppj0vSoLRj32MMOAWnOEGQsnoBMU3ZbtKOfikbLwIEFCumMxA5QcZIop0DwhXxhhivtR6tb4dNh24SNcNGh1HWbgFj6jn0eF2S1tpCgP9mmW7NZWdoS6zJ/nX5l/Y/W6bz5i3ifUH28mjrCk1c2CPMdvKO+Io/ZURCEGGhv6wd4TFWJh55+A6sskzntRYFj0M1XtSc8M1IjXEisOWyebPtyAgiDHTpg/tyy3TetxnAmeWZrxth9+U4kyltRYFA7TdZkRJkdH1eMt4F9pbFs88/CuCm3XSXWqZ98ub/q6/U30q9PLHdPQ4PpI3wEWCmj9kF+/rYlliTDfWv7tvbqyo3ANgr/NDi1cjAj2zTmWiR1l9S9/RAv4vXC2ktAgTOskzn6kQIMvpMsqZ/R69avQLME799IwgyDpXfskzn85sNiS0Ssk1EHLBHa4OJv2jn3W8kRpCJJUlJXUigaY5EG3542onoq5W8/WVJkPAw7RBN51qmM+3zROTPILWC18qaqYgDVxxTJYswM0C40so752xWOWNQfUdVoVhaEocZhtQ1FQFmOtUu2D9O/A6y2YFtbsU2zgz9BwCflKZkEfH1lfxrTXH0kv7PBH4+TTFIX6cjkMhr3lYSYZS0FwH8UytzO2IO43ar4ExUA9n6l9jW1bRXOsI36URgBBTivYfy7rSXLYkssSbW76uMN8HzxFfoNI37LNN594TDYycJR9IUgPR1OgIK9e44lB96qWOWWMKRXFm/hJkXpSlhoilLxXR2n+yzUdL+CGDXNMUhfZ2KgGU6NW8Wyd5BSpoo8fL6lCXrJct0dpxKEH0pwK+dD0lZQJl3t8G5/sQIktqHW8KwlXfUKQTJwA7mLifRFZbpnFsrxsQIkivqi5n4gjQCv+UDXZfuOUtjaoL5zPx+q+De2lEEMYr6K2mtzkiEz1TyzjUTgI4VQeiEI7fBLpCMS9V7QBewJHIH0cv6LGJ+Jr15mV5aM+miDenFMmnP+QHLdOs2V02EIEZJE+e5a675AsB1NzP+QKB9QbwvgL4AOvyKvGiZzpsmCyVc9sev/3L+awhM6ys5GZykCCKWI+0e1r+XPfqKPWCL6o4TY8ZqdY8RT9mXPN4XBEEY8WebsK+ILV8LJlg4LuzQsqTvpR6vb69NA5vqFsyOnSDjJYLEd4Ngg/h+hvIVO2+3XEVEH9R3ol5vH6oq+/LYXUZ8s9gZQE8wJwAmOtTO26LU0dhIqvRo0ACknEBgys7sWpDEThCjpF0J4Gzf+SG+X2G6ZMh0RNfYUIY47IQe7KwQZoHxFgb3MyFH4H6A+hni36NLNtFXb4iJh4hhgWExcWXLomhJFK8OBYiMKiH2DqgUhtc1Cj8JglTEQUMfObmXGN8I0uPah41QpsrXvaHAGJeSn1umc0IzY7ESRF2h7t7TR483c2r054x7SMHllbwjGtKkZhilmBvopAaZznLUUzDgzHuttlk972IliFHSvgvgrIZQEdYQ83cqpntbZ0HamjcJtGBrzTE5awKBLY9Nd8wSyyhpboPXsKug8DXWvNpfNNOUXyP+Jp5pgidhX/kVr4fmOIe31tMxtjtIveIGo03mFb7Wyrs/Sxi50MyP9/4O1IIsNCekopoIMPGFdn5qV+KOuIMYJU2Ut5/opcfAIHm8xBroHmJMBtooaneD4Ks1s7ymI0fgt1avMwdzYbdqKbY7iFHSPLG1hYEVpPCSblhKNQLZKKkLAGraZrjVRMl57SOgAEf4/UwQC0Fypb59GcolBF6S1ofvIOnRS9odBBwVRFbKhIsAgy+wTfdSv1rjIcigdkxlwLndr3Npn28M9h0EhVYAtF3aY0m3/7TMMu1AxUFiIUi6wW3Pe72snkxMN7anRUq3gcBTPEIF+0j7uSA6JEGCoOZTRh9ULyKFvuJTTE4PA4EGh6FaUS8J0gpKIcwxSuqNAKW97GoISMSngkEftU1b1IQOPCRBAkPnU3AZDGNbdQ1AB/mUlNMDIECET1byzg8DiE4RkQRpF0Ef8rli7o1MI4/Kh3YfoAWY2mpL7FZUS4K0glKIc2Qt3xDBrKWKcKuVd0LrAS8JEnG+aqnXB/VDSeG7EzDd1SaZsNLOO6F+d5IESeiSyZX7DmBWHkzIfBeanV5II4wgJUHCQDGgDr2szyXmKWfqA6rKtBgD19qmc2YUIEiCRIGqD525Vdox7GG5DxE5dTIChMutvHNeVKBIgkSFrA+9WlErKITLu6GHo4+w254adH+VH8OSIH7QinBuf7n/DR4PXw7QRyI000Wq+WTLdJdGHZAkSNQI+9RvlLQvAKN3EzlqIUB4mZmOt0373jgAkgSJA2WfNsaro4i9W4f5FO326fcx6MO2af8prkAlQeJCOoAduclxKmj1mtwEgLZlEUmQlqFKZqK8m7yGO3t8ij3g3hRnJiRB4kS7DVu5sn4GA2eAeb821KRaVBzXtk1nfpxBSILEiXYItrJOlLiXWZIgIVy0SajQi/q/AHwiUbbOvLNC77Xn2ffEhbkkSFxIR2RnfE/XiSCcCMZbIzLTMWqj3FZS+61yx4QuHWkLgUH06z3qccQ4EhB/OrhQBOFhMN4ZMN5Nlum021umZdPyDtIyVOmZuNWd2M7tVY/sELL8LwhrAV7LpKy1d7TXYg+46qC6W08PfROMY/wi6zF2dQrOU37lgsyXBAmCWppkVmArXdUPBLwDielAAOLI75Q+7+GGw2sBWgsaJ8Q8+/lG+sfOxnjf9HMUmcGLbNP9Wrh+19YmCRIHyh1mQ7tTe1tPD2Z7oB2IvR2g0A5gfgMx7cDgrRjUT4R+YNIfwkYwNgLYBKKNYN7IwJPEeJIU/LEKPOnknSeDhmoMqidAIdG7cqdmOgh4omI6uzebF8bPJUHCQFHqCA2B3KD2aVYgiCIIWndYvc5MzMWm0AzXUSQJEjXCUr9/BFZA0/vUhQS6qJ4wMZ1eKdhL/Cv3JyEJ4g8vOTtGBPSS/s8EXji5K8Bm8wSUK6ZjRu2OJEjUCEv9bSMw/q1HEGVKtZI4vqpLgrSdPqkgLgRyZe1oZgiiHCJsEnB0xXTuiNK+JEiU6ErdkSCgD+qnkSKWXvyAZbqnRmJkXKkkSJToSt3RIcAgvaReYBdab6cWxBlJkCCoSZmOQaB/Tf+OQ3OH/hKVQ5IgUSEr9XYFApIgXZFGGURUCEiCRIWs1NsVCEiCdEUaZRBRISAJEhWyUm9XICAJ0hVplEFEhYAkSFTISr1dgYAkSFekUQYRFQKSIFEhK/V2BQKSIF2RRhlEVAhIgkSFrNTbFQhIgnRFGmUQUSEgCRIVslJvVyAgCdIVaZRBRIWAJEhUyEq9XYGAJEhXpFEGERUCkiBRISv1dgUCkiBdkUYZRFQISIJEhazU2xUISIJ0RRplEFEhIAkSFbJSb1cg8P+GamNQVETlcAAAAABJRU5ErkJggg==",
"socialType": "wechat",
"socialUserId": "oDuIHs5cmy_drtCimQAjheVyIMJE",
"bound": false
},
{
"name": "Alipay Logon",
"enterpriseAuthId": "ciammasteralipay",
"logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAWc0lEQVR4Xu2dCZAc5XXH/69H14LMqZmRwLE5BAajAgwogG2BZMABA3bhGByMiQtTCIOjAAZtzwpSXkNAOyMpggRzxLHLJDZxhLnkWDIxEggEAYGEBcVhccQCITQ9awmBpNWx0y/1zQ5Cx87x9fT5zeuqrVFp3/e+9/6vf9vT3d9BkEMUEAVqKkCijSggCtRWQACRs0MUqKOAACKnhygggMg5IAp4U0CuIN50k1ZtooAA0iaFljS9KSCAeNNNWrWJAgJImxRa0vSmgADiTTdp1SYKCCBtUmhJ05sCAog33aRVmygggLRJoSVNbwoIIN50k1ZtooAA0iaFljS9KSCAeNNNWrWJAgJImxRa0vSmgADiTTdp1SYKCCBtUmhJ05sCAog33aRVmygggGgUelSOJ1ouJmo08WTqFKjbU0Np5LsCAoiGpBVAGI9pNNE2ZeDxUp4maTeUBoEoIIBoyCqAaIhliKkAolFIAURDLENMBRCNQgogGmIZYiqAaBRSANEQyxBTAUSjkAKIhliGmAogGoUUQDTEMsRUANEopACiIZYhpgKIRiEFEA2xDDEVQDQKKYBoiGWIqQCiUUgBREMsQ0wFEI1CCiAaYhliKoBoFFIA0RDLEFMBRKOQAoiGWIaYCiAahRRANMQyxFQA0SikAKIhliGmAohGIQUQDbEMMRVANAopgGiIZYipAKJRSAFEQyxDTAUQjUIKIBpiGWIqgGgUUgDREMsQUwFEo5ACiIZYhpgKIBqFFEA0xDLEVADRKKQAoiGWIaYCiEYhBRANsQwxDQ0QdXKZoFkYC8cx4UcmaDVYDr099HiScgsNkLTNjxGCX7YzSeK3W6wuYZIAUqPqAki74bB7vgJInXNAABFABBABRCioo4AAIoAIIAKIt3NAvmJ5082kVnIFkSuISeez77kIIHUklfcgzZ1vagMdeQ/SnFZhWIX2HiSMZILuQ96kB61w/PwLIBo1EUA0xDLEVADRKKQAoiGWIaYCiEYhBRANsQwxFUA0CimAaIhliKkAolFIAURDLENMBRCNQgogGmIZYiqAaBRSANEQyxBTAUSjkAKIhliGmAogGoUUQDTEMsRUANEopACiIZYhpgKIRiEFEA2xDDEVQDQKKYBoiGWIqQCiUUgBREMsQ0wFEI1CCiAaYhliKoBoFFIA0RDLENNYAJKkyVRhLByXxHOLgNVOni5KYuz1Yo4FIBmb2TRh2y0fAq4u5uk20/IWQEyraFT5WPi8M53+N6rug+pXAAlK2XbyS1jpvIlDcR+VTUtbADGtohHkw8CvSnm6MIKuA+9SAAlcYvM7IGByMU8/MTFTAcTEqoadk4uxzgx6M+xuw+hPAAlDZYP7IMKiYg8ZsffLYGWKBSBJeg+SpHM96Hc2VS1+6OTpxiTpohNrLADRCVhsm1MgnePziTGnOWvvVuzilNIMetK7h3i3FEDiXR9P0YUFB4AVTp4+4ynIhDQSQBJSKJ0wMzm+E4zv6bTxZEu4y+mhKzy1TUgjASQhhdIJM5Pj+WCcqdPGiy0D3yzlKfCvcV5i86uNAOKXkjHyk7H5dQBjAw7pwyH9OGT1LOoNuJ9I3Qsgkcrvf+cHdfOITX3o89/zLh4Zc50CfS3wfiLuQACJuAB+d79/Fx+RcvGq33539ceMKaUC3R50P1H7F0CiroDP/adtPouAeT673dXdhn7GkWsLtCrgfiJ3L4BEXgJ/A0jbPIWAf/bX627efuHk6eKA+4iFewEkFmXwL4iMzfcD+Lp/HgfxRPiG00OqH+MPAcSgEod0g/6GczyOwAXmzf0Y7FQQQAwCJNvJlzLh3wJOaaaTp6kB9xEb9wJIbErReiAZm9XN+Vmte6rjwcIXnen0VKB9xMi5ABKjYrQSyqhpPMYqY3UrPhq2JTzp9NApDe0MMhBADClmSE+vrnXy9E+GSNZUGgJIUzLF3yiEr1fb4OJIU2cO1qqwABL/c79hhOkcjyWGGn8V2EHAfcU8XRBYBzF1LIDEtDA6YWVtvoGBm3Ta6NoScFExT/fqtku6fSIA+eQ13NE/AiM5hZG8GZ9ACiOV8OxiE4CNbj82lRkb39+EjfhX2pb0oujEv6/New8FlgE4RKedji0z3hm6B45Y3U1K77Y6YgPI6C5Ouy4OY8LhYBxGwOEADsPAZ4dGVT4A8A6AVQysIsY7pP5NWEVlrCjOpP/T8BV706zNVzFwa5CBEvAvxTz9fZB9xNV3NIB0s5XpwxlgnAHCBAIOY2DfkETaDFRGu75KhFfYxasp4NX3ChT4CFjf8xvQUV09jvHd9w4OiXBasYcWBtlHXH2HBkg6x58jxiQGJhJhEnjga1KcDgaeI+B5ZjxnEZ4v5umlOMW3ayzpHH+XGD8NOMYlTp5ODLiP2LoPHJDqAgKXBP6GNxiJ1dXmeVTB2cZ4Ik5DvDM2q9VEvhhM6lWvhCucHror0D5i7DwwQNKdfAlZuASMCTHO30toLwP4H7bwaL+Lp9blab0XJ622Sdt8AQH/1aqfBu1fcjpwHLqpP+B+Yuved0CyXfxVZnSC8YXYZu1vYI8w8ASAxaW38FRYK5yH8GIQzLiqVKCg55b4Ww2fvfkGyD7dvM/wPsxi4Ls+x5gcd4R34eJxAPOHbcP8VbNpbRDBZ7v4HHbxmyB8f+STgNdSHTi+HR/t7qirL4Ckp/GxVMaPAXw+yKIlyjdDwTE/CFjSNs8l4NyA9Zjq5GlmwH3E3n3LgGRyfB4YD8Q+0ygD9BGWMK4eAN7a2oHj3++m96OULQ59twRINsfXMKOtRne2XLQdYHGBub0F+lDHZxhXDwauL+XpFp24TLX1DEgYN4mmir5DXquY8YD66Z1BixrlG8bVgwjvoB8nFGeS0yiedvi9NiBhjBxtB+EHyXExER4ou5jXW6A/DqZBGFcPMH7kFKi7TWuwW9pagIyaysdZFpaKeIEqoAYEPkCEeZuB363voXWqtzCuHgCK/YwT4vQyNFClm3DeNCD7dfInh6jLbwgHA+qkWKMKBkYRFooErK8OTxmpPpkqQ1UqP0TYc/vvBv5vWAhhhtHFKwDmEeN3LuGqoJ9cMXBLKU/Xh5FYUvpoDpBuHpbpw9vqD5lPiW1g4DEAzygAmLBGfbpDUVw7FEV009ZW+slexxmycFSZMI6Ao8AYB8JRAPZpxa/hbdcSYXyxh94yPE+t9JoCJG3zEgLGa3ne2XgLA08TYxFSeDSqVTHUVTDFGEepKjTA54IeCduCZuE2Jcxweqgz3E7j31tDQDI2/xrAX2um4gJ4Wv2QhSc7huPRP3WTGvgXu+OAa3lU/1CcChdfYsIkAo6MXZDBB7Sh3I/xf55FrwXfVbJ6qAtIxmb1juOaZlNirixa9ggPwVO9t9B7zbaLk92oLj48VcYEpsooWbXETWAz9eKSNwO3lfJ0dVziiVMcNQHJ2Py3AO5pJlg1od8Fbi/lSQ3aM+rIdvJJbOErcHEuCMcaldxAMlvU1+e4z32JSvdBAdn/ej4w1V8ZdNdol6JeMC5zCvRQVAmE2W82x19ixjlA5UdNB07+QbjD6aHvJz+RYDIYFJBMJ98NwuQGXS5nF2eWZpB6HNteBzNlbZzLtB2WMYkUgMGuhfG9PSTvtmoUcDdAmpyI87KTp3GJPCl8DnpUJ38iZeEc5sqDDN2HGT5H49ndArWn+patmPP+rTJAcUcVdwLkwC7efxvj8cp7g9qHwFFDm1E5Pt5ycSEIFwI4wPPpGm3D+UyYwy7u1x1IGW3YwfS+EyBpm28l4Kp6cFgWLlgzndQbXjlqKKD+0GxlXEguvgXCyQkW6mEC5qCMh4szaWOC8/Ac+nZAxtj8qTLh5XqrjTDj/FKB1HsROZpUoDKGqlwBRV1VEntUnlQy5uy5B/47ru+0ghB3OyAZm38AYFadTn7i5KnRjXsQMRrhUy17ZDEuYUCt8BK7JY80RN4Gxhwi3Fdch3mmr2S5IyBqU5TBp8wy1qbKOO69WbRSQ0gxHUSBzA18KG2F2glKgTI64SJtrHwFs/BA8Q3MD2vBijA1qwCS7eTTmPBozY4Zv3QK9O0wAzO9L7XUatnFpQRc2sT7ptjLQcA6RuXmfm5pBgW9DXVoelQAyXTynSB8rw4g33YK9MvQomqjjsZO4eEf7IlLwRVQjjMkdTU9YQ4Dv3Xy9EiSc6JKgfaozPNI10hk/bCtOCSoJWySLJ5fsVdXn5zjl784+VFTeJnxazUBrNhDtb+lxCnoHWKh9FQ+jCysqBVfNbGzYxp/4sOqTkR7zoD7kWZq8SaAB4kwPymLYVOj+w9i3FAs0M3NZC82+gp4nE6g31HMWrBaXR/4javm4DexYEVU4VNlDV3Cz2oF4BIm9faQGrgoh88KpHNsE6PHZ7dJdLdcfVNxGfNKeVocpwQok+MbwfiHmoBswQG9tyZzbkechN41lmyOv8mMX8U5xohiW8ZqHj4w38mTmnQX6UEZm9XTqW/ViGK9kyeZx+1zibJdfCK7eMZnt8a5q+7XMp8szCtOp2ejSJDSNj9GwMQanbf15ilBFCQzjbMoQ22hsH8Q/g32uQyMBSAscNZhYVhv8BsB8oKTJ1Oezcfi3MnY/AJg5MzE0PStPjpeAMZCF1jQW6DVQXVeFxC1u2mpQJ8KqvN28xvKyojtJiqwmRgLmbAAwAInT8v9lKDRFWSTk6c9/eywXX1lcvxjMK5s1/zDylvdt1gY+CpWHIGF6Ca1wo7noxEgsCxk1kynkucepKEa69bDBFukCF2BPzGwwAIWcgoLnFuoqBtBQ0DkPYiupDvbZ21WY5LOb81L862ZoPYuvAac6IlazSfcvOVGBhYS8DgsPDtsM5atmk19jZpTwwUaCN93euiORo7k97srkLH59wBOD0sbNYS+1EM/3++HvNeQPvyACH/BgLqHDC2GsHL1oR+HgWctYIkLLGXG8sFu9imb48nMuLtWhwT8rJgnNdJUDg0FMjl+IswdfpkxpVSg2wcLcZTNZ1vAZQC+ppFCu5luAPAsCMvgYrlF+MOaPL2sXhSqSVJqslSt449Ono5oN7W85pvN8SHM+E8Af+nVh247JuRKPZRv1C5t81k0AMp5jWzl93AJWEb7XM37DBte2W6g5pFifPa9Ar0qotVXIHMdH40U/j3MBbEJ6CnmqUunNhmb/woDoCR1mSKddFuyHZgw1eDllYzobaxxupO/QRZuBePAxta+Wdzr5Okir96yOT4djMlhPkTwGmtU7SqANLHcz4phW3FsM3f9USUSZb9Zm6cxEPaUgMVOnib4kbdaUtVlXEbA3/jhzyQfA3PSc3w6M9QTl9oH4wqnQHeZlHyruexr895DCbeB8Z1WfWm2f9vJ06c12zQ0H53jiQqUOoNXG/owzeDjVU06eTkIR9dMkPDisC04Sa4iAwqNzvF418VtUSwM5+Sp4b4urZyoaZtPqd7Mt/1CHduFTtt8MwHTGghrO3kqtCK+CW2rk8xmRDAiN5ArR62aZLr4C2r1/giukLE5TT6+gnTxyXAru0LVO961LHy5XZcerS7+1hXRTa1v9xy6Z1+mi08mF5dVF73TbZ5o+50u1Rmb1XpGZzXIqC0Xr07nuIu4coWNYlXElp5W+XWGqolerlu5mW+bF8c7L16tHlUS7mtC0LaBpPJyjdAV5lvxHfX38p6jifq1ZFK5/xq4mVc/Rh+73exlbF5U3ZuvbuKsBn19iHNLd5B6RW/cUd3KYHITGwkFmfuVTp7uDLKDVnyPmsrHWanKPYoCJdWKr7i23X0DnU7+DhF+3mTAT4PR7RSo/iPiJp3FwSwmYLztAlf25um3cdCkUQzpqXwsfQzK0Eb2Sfr9oI8LszY/x8AJzSZChNtTKRRW30xqhcZEHjEBQ2m3mIArk7ipphpqQ0NwGQ9cUYYn8kTYJehaexR+HYT7NRPsJWAuLDxcnE5zNdtGYp7u5pHWZpxd3Zgz+mf+hP/YxpiyLk/rIxHEp05H23xUmTGZqAJKh09uI3FTbxtoNQfkCo9RvcTAvUOAe9/L09sefQTTrJut7CacwxbOxsCOtXHYKm0bEexiD80OJulovI7p5CPLChL1w5E8/Ws58ZqAjJrGY6wy1A17K9sdq7+E9wJ4hl28WJpBf2g5Yg8OxlzLny4PwYTqk6jTQDjUg5ugmixxCbbJq1eO6uTPVOajWBVQ9gpKyCD81h2ykOnii+FWhm/7dawlwksu4wULeM5N4ZWtLlau76G6w+11O0/neCy5GMeEU6trfh2r6yMk+7u3AXbSv1I1q1VlofSBr13qqpKIBQkbjunJ2KwGKF7erAie7AgfwMXbTFhJjJUgrFT/ZmC3SfbE6ABhJFyMrHwSRlqMMQyMrV7t1GfcjzcA3OTkyc8/PnHPeXt8alKZejTMPUYfb84B94QEBV82uYlBIyPcyIJiu1ul3FjkIudJUWL0Tk+qDwwzF5dVWrtTxNpOk0Bst8U3mvIHlhr6sugUCpAeJFd3CS7BO+uttphuR/bQcmGUo8mO2kKEOWr8tbUwtIm/YrZxwpsIWD2ZkLB73st00Subib00RCWMXHIr2lAKpDkeKLFeCwOgSckhl+4Lmb3zqBlCYk3FmGqJ6ipMi7lgUGRB0UZlBYgAklzpVLj1CzG7GIhGS9Mm8sqfKu9c7zvcB7YCZiBSFbW0QZEIKlzojCeJOCeYoF+Gv7pZHCPk3loej9cTgM7AYf6yN4TIKoUo7v4s65b2edCDuAhMO5xCvSQiBGsAlmb1cQtBcqJwfY04N0zIDtAorYvPiqMYGPWx4cMzIGFe0rT6cmYxWZ8OOoltrqiMOPUIJNtCZDtkJQxC4Qzgww0Rr4XMPCgOwQP/flmejdGcbVlKGmb1WLd6ory5SAEaBmQj4JKd/I/EuH6IIKM2icBr4HwILl4aE2BlkQdj/S/uwLpqfwVSuFyML7qpz6+AaKCynbxOa6LyQSc62eQEfn6PatH2ozFpRnyFSqiGmh3m+7iCZaLv2PgAu3GgzTwFZCP/Gc6+QwAh1ZGzaq1thjHKH78CDhAHysALAJj3hYLi+SlXoBKh+BarUBDLq4B4eJWugsEkMECquzuug3HwMLRFWhcHFN3obpWsmrcdgUYS2FhqdobAi6W9hbow8bNxCJpClRGEFuYioH7FEs3/tAAqRVY9jo+GENwMFwc7AIHE+Hg6ttT9dnKcIN3GXgdjDeIBj7h4o1hZbwuq0PqnibJt09P5dFkoRNUuU/Zo9mMIgekbqBq9t8GdAwZihF9ZXSkLIywGB1EGFFWnxa2cT/6mNA3lNBHHdhU3oC+4kj0tbp5Y7MCil2yFFDTrGkzOokr9yn7Noo+3oA0il5+Lwq0oEDG5k4AV9f7piKAtCCwNDVDgYzNau0FBctuAyMFEDNqLFn4oECmky+Guk9hjPvInQDig7DiwiwFMjk+D1y5opwkgJhVW8nGRwXUxlICiI+CiivzFBBAzKupZOSjAgKIj2KKK/MUEEDMq6lk5KMCAoiPYoor8xQQQMyrqWTkowICiI9iiivzFBBAzKupZOSjAgKIj2KKK/MUEEDMq6lk5KMCAoiPYoor8xQQQMyrqWTkowICiI9iiivzFBBAzKupZOSjAgKIj2KKK/MUEEDMq6lk5KMCAoiPYoor8xQQQMyrqWTkowICiI9iiivzFBBAzKupZOSjAv8Pzr2E6MhjgZQAAAAASUVORK5CYII=",
"socialType": "alipay",
"socialUserId": null,
"bound": false
}
]
}2.9. Attach social platform
API endpoint
Request URI: POST /api/bff/v1.2/developer/ciam/user/social/bind
Content-Type: application/json
Request parameters
{
"code": "061upd0w3o9vGY2Sf74w3anqDM2upd0P",
"enterpriseAuthId":"ciammasterwechat"
}Parameter name | Type | Required | Description |
code | string | Yes | The code from third-party authorization callback, for Apple ID platform, you need to pass the identity_token returned by Apple |
enterpriseAuthId | string | Yes | Authentication source ID |
Response parameters
Binding successful
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655104186558$e44d6012-cd7d-e6b0-3522-8d14be15ad8c",
"data": null
}Error codes
Error code (message) | Description |
Operation.Failure.User.Has.Bind.Other.Authentication | The current user already has a binding relationship |
Params.Exist.SocialUser.SocialId | The user from the third-party authentication source is already bound to another user in the CIAM system |
2.10. Unbind social platform
API endpoint
Request URI: POST /api/bff/v1.2/developer/ciam/user/social/unbind
Content-Type: application/json
Request parameters
{
"enterpriseAuthId":"ciammasterwechat"
}Parameter name | Type | Required | Description |
enterpriseAuthId | string | Yes | Authentication source ID |
Response parameters
Binding successful
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655104186558$e44d6012-cd7d-e6b0-3522-8d14be15ad8c",
"data": null
}Error codes
Error code (message) | Description |
Operation.Failure.Social.Not.Bind.Over.Error | No binding relationship |
2.11. Delete account
API endpoint
Request URI: POST /api/bff/v1.2/developer/ciam/user/unsubscribe
Content-Type: application/json
Request parameters
{
"fId":"xxxxx"
}Parameter name | Type | Required | Description |
fId | string | Yes | Flow ID, the preceding flow is 2.1 Operation check |
Response parameters
Binding successful
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655104186558$e44d6012-cd7d-e6b0-3522-8d14be15ad8c",
"data": null
}2.12. Enable gesture login
When a mobile device needs to use phone number authentication or IFAA authentication, face or fingerprint recognition needs to be enabled in the security center. This API is primarily responsible for face and fingerprint authentication. Only after authentication is passed is it considered truly enabled.
API endpoint
Request URI: POST /api/bff/v1.2/developer/ciam/user/gesture/bind
Content-Type: application/json
Request parameters
Parameter name | Type | Required | Description |
gestureSign | string | Yes | Binding gesture, AES encryption result of the user's username for the gesture |
Response parameters
Parameter name | Type | Example | Description |
code | string | 200 | User identity information token |
success | string | true | User access token |
message | string | null | Used to refresh user token |
requestId | string | oisadjflkjOIUSDALKF | |
data | long | 3600 | Token expiration time, unit: seconds |
{
"success": true,
"code": "200",
"message": null,
"requestId": "1649403963427$c4b99c2a-66b6-8709-7dba-9c3dd36b1d29",
"data": null
}Error list
errorCode | errorMessage | Description |
Operation.Success | Operation.Success | Success |
Params.Blank | Params.Blank.Gesture.Sign | Parameter sign cannot be empty |
Params.Blank | Params.Blank.User.Username | User userName cannot be empty |
Operation.Failure | Operation.Failure.User.Not.Exist | Cannot find user corresponding to userName |
Operation.Failure | OPERATION_FAILURE_GESTURE_SIGN_ERROR | Signature verification failed |
Operation.Failure | Operation.Failure.Service.Internal.Error | Server internal exception |
3. Personal information
3.1. Get personal information
API endpoint
Request URI: GET /api/bff/v1.2/developer/ciam/user/info
Request parameters
None
Response parameters
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1677556641231$543adac6-4089-fc12-11b6-a285a150613e",
"data": {
"uuid": "ccfeacc7ffb0c5ec5b2d73f18a9c6203P8gjrPLe4c5",
"username": "d123456",
"password": null,
"enterpriseUuid": "a48708d5b95fe8f935252ddc8500254bvNEfoDffUqV",
"externalId": null,
"phoneNumber": "151****2326",
"phoneRegion": null,
"email": null,
"enDisplayName": null,
"displayName": null,
"unionId": null,
"userTypeUuid": null,
"enabled": true,
"locked": false,
"gender": null,
"birthday": null,
"country": null,
"region": null,
"province": null,
"city": null,
"street": null,
"address": null,
"avatarUuid": null,
"fullName": "************************",
"updatePasswordTime": null,
"baseAttrDictionaries": [
{
"enterpriseUuid": "a48708d5b95fe8f935252ddc8500254bvNEfoDffUqV",
"uuid": "46b13e088966a93daa01d42ccacc0e88zk8mIRyXO0J",
"fieldName": "Full name",
"fieldValue": "fullName",
"dictionaryObjectName": null,
"dictionaryObjectId": null,
"dataDictionaryType": "USER_BASE",
"dataDictionaryFieldType": "TEXT",
"modifiable": true,
"enabled": true,
"unique": false,
"needRelation": false,
"needShow": true,
"needSensitive": true,
"remark": null,
"dictionaryValue": "************************",
"dictionaryValueUuid": null,
"selectFieldOptions": [],
"customAttributes": []
}
],
"userTypeDictionaries": [
{
"userTypeCode": "test",
"userTypeUuid": "ba70b179e2021aa142abce40861a9d37tkPHfzP9GdY",
"userTypeName": "Test Type 1",
"dictionaries": [
{
"enterpriseUuid": "a48708d5b95fe8f935252ddc8500254bvNEfoDffUqV",
"uuid": "73560582a19ed20b1ea7fea2e80210a3pt3PVyFrm8T",
"fieldName": "Test Extension Property 1",
"fieldValue": "qwer",
"dictionaryObjectName": "Test Type 1",
"dictionaryObjectId": "ba70b179e2021aa142abce40861a9d37tkPHfzP9GdY",
"dataDictionaryType": "USER_TYPE",
"dataDictionaryFieldType": "TEXT",
"modifiable": true,
"enabled": true,
"unique": false,
"needRelation": false,
"needShow": true,
"needSensitive": false,
"remark": "",
"dictionaryValue": "Test Extension Property 1",
"dictionaryValueUuid": "f1ee692c444c1f5f3751a154e54fc0faP7ZTBkj0MAy",
"selectFieldOptions": [
{
"uuid": "2edfcc0c96dd674ec62c59ee5c85f5ce4iMyC0S5NEm",
"optionId": "1677033711339",
"optionLabel": "",
"optionValue": ""
}
],
"customAttributes": [
{
"uuid": "4fa97b76d92742cfc43fd9fcdded9f1f0DS3stpR053",
"attrId": "1677033711339",
"attrLabel": "",
"attrValue": ""
}
]
}
]
},
{
"userTypeCode": "default",
"userTypeUuid": "3762b69d9f2580c7901441719733271b22zUqxkuQDh",
"userTypeName": "Regular User",
"dictionaries": [
{
"enterpriseUuid": "a48708d5b95fe8f935252ddc8500254bvNEfoDffUqV",
"uuid": "2da98cbd3abb33230c2937dcf29da34dJvPc8zSLqkB",
"fieldName": "Regular User Type Extension Property 1",
"fieldValue": "s1",
"dictionaryObjectName": "Regular User",
"dictionaryObjectId": "3762b69d9f2580c7901441719733271b22zUqxkuQDh",
"dataDictionaryType": "USER_TYPE",
"dataDictionaryFieldType": "TEXT",
"modifiable": true,
"enabled": true,
"unique": false,
"needRelation": false,
"needShow": true,
"needSensitive": false,
"remark": "",
"dictionaryValue": "Regular Extension Property",
"dictionaryValueUuid": "c4eb28de41249cecd041f0b605ecedfblrAOJgGFaF7",
"selectFieldOptions": [
{
"uuid": "0a9af922a7495c4fdf3a76d127794e30NP2JZP2qLKK",
"optionId": "1677499975276",
"optionLabel": "",
"optionValue": ""
}
],
"customAttributes": [
{
"uuid": "2571b9a9181b962f0ece9e14379529f0vNo1rZjQab7",
"attrId": "1677499975276",
"attrLabel": "",
"attrValue": ""
}
]
}
]
}
],
"userSocialList": [
{
"userSocialUuid": "537c4e34d99942f30b3e2c1b08d90b92lKATczY5T73",
"name": "WeChat Logon",
"enterpriseAuthId": "ciammasterwechat",
"logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAb0ElEQVR4Xu1dCZQdVZn+/uruWl4nbCIyLnMkCEGQTTYJioS8eg0EEBSCCuIoAurIUUQgiFFAjSAMLoALhhkGISNRQYIk9HsvCSBLhIiMgChbwEFGHCRo0q+W7lf/nNvdabrTb6t6tbx6de85OQn0/bfvr6/rVtW9/0+QQyIgEaiLAElsJAISgfoISILIq0Mi0AABSRB5eUgEJEHkNSARCIaAvIMEw01KZQQBSZCMJFqGGQwBSZBguEmpjCAgCZKRRMswgyEgCRIMNymVEQQkQTKSaBlmMAQkQYLhJqUygoAkSEYSLcMMhoAkSDDcpFRGEJAEyUiiZZjBEJAECYablMoIApIgGUm0DDMYApIgwXCTUhlBQBIkI4mWYQZDQBIkGG5SKiMISIJkJNEyzGAISIIEw01KZQQBSZCMJFqGGQwBSZBguEmpjCAgCZKRRMswgyGQSYLoZX2W4vFuTJjNjNlEmA2wASIDHnIgGKP/DTIA8W8MgVGBgiEGhoipAvAQET/nVfE8SHkOhOcwgufsI+3ngqVCSnUiAl1NkFwx90b0VPf2PN6boOzD4D0IggzoizIZzHiMiB5l9h5TQI95TI/aA/b6KG1K3dEg0FUEMQb7DmLQkdRDe4GxF4Cdo4EtgFamDSAUmVDy4D3g5t3fB9AiRWJGIPUEmSCFgiMAOihm/AKbI+AJj3E/KVy2LHc5jkElsDIpGBkCqSRI/519e1eJjqeUkaJuFhn/A8JtnoflzoBTiizbUrFvBFJDkJlrZm5fHRk+3gMfR8BRviNNj8Bv2ePlTHSTU3CeSo/b3elpxxMkV9SO8giCFMcD2L4701AzKpvASz1WltoFe1WG4u6oUDuWILmydjQDZ4BxTEchloAzBJQ90FLbtP8jAfOZNtlxBJHEaHQ98lpm5Xt2wf5xpq/aGIPvGILoZX0ugc+Wd4wWss9YDeJrLNO9pYXZckobCCRPkBXQcn36IgZf2EYcWRW9DVVvsXXE8INZBSDquBMlSK6kzWfmRaD0fL+IOiEB9NtMvNh+xV2MBagGkJciDRBIhiC3I2fo2tcAnC2zExoC9xFjcaXgrAhNo1SE2AnSX+zbxyPl2wDeK/GPAAHGldZ2zkLsj+EItGdOZawEMcrqSWAS5Ngxc0jHGTDjHijKQitvPRCn2W60FRtB9LK6iJgu6UYQOzImsT2fsNAynas60r+UOBULQYySeiNAJ6cEk65yk8A3VEz3o10VVIzBRE4Qo6wvA/OJMcYkTU1HYJVlOnkJjH8EIiWIXtJWEsQ2dDmSRkAc4rILzp5J+5E2+5ERxChpTwDYLW2AdLm/f7VM5w1dHmOo4UVCEKOkWQD0UD2VykJDwDKdSPIemoMdpCh0oIyytgGMbTooRunKlggwnrYKzi4SmOYIhEoQo6g9BcLbmpuVM5JGgAkr7bzTzQfPQoE4NIIYJfV+gA4OxSupJB4EiH5q5e0F8RhLp5VQCGKUtNsAHJtOCLLtNTOuswvOJ7KNQv3o2yZIrqhfwsSLJMDpRYCZL7QL7uL0RhCd520RRCtqBYUwGJ17UnNsCHj8IWvA/Uls9lJiKDhBRresq6vTVIsqJTlJys2XUfXmy8NXU+EPTBCjrF0BxjlJZRPASwDuBfAnAOvJw9NeD2+HKnYhUmZD4flgzEzQv0amHwboD8J3YjzjEZ4GMEsBZrF4C8gsnudETeBYhygOUTEdM1ajHW4sEEFyq7VjuQrxYJ7EsAFczQpdbc+zn6/nQK7Ytz+TcjmAw5Jwso7NZ4TvVq9zNeZipJ5fekk/jIi/M14+NV73CZ+z8s534jXaudYCEcQoaeI39yGxh8VYrii8aCjv/q5V20ZJfT9AP291flTz2OOL+3q0qzbmN/6tVRv6oHoRKfSVVueHNO8vnoJ3O/McQebMD98EMYrqeSC6LAHkHu211cM3HrPxZb+2c0V9MRNf4FcuvPm01DLtQNv9jbL2CBh7h+dLc03MWGIXnNObz+z+Gb4Ioq3WZise7gXHW+GQgb8TK/OtgnVfoJTcD8PYpD0MSmTz5L2W7QwELU5tFI1DQJ64Y8c6iPG+SsFZHqvRDjTmiyC5knodgz6eQByft0znW+3YNYrq+SC6tB0dgWRJmdPu0VejrC1PoF6YPEMCtF60YbRED/DLQBdJu0JhXGRF9UQQLWvXFX/y/Ipluq/zJzN9tlHWvg3GZ9vV41eemE6vFOwlfuW6aX7LdxCjpN8McBL7dizLdHLtgq6W1d17mB5vV48f+bA2BObK2qeZcY0f22HMHT1kxc67MIChMPSlUUdLBBFNaqAoaxMK8C7LdOaGYdsoaRyGnlZ1iDdX9oB7Uavz680bfe0LXtOuniDyWd+G0hpBytrVYPxrEIDbliFstPLOVu3qGX3BUIX4OBffINxu5Z22N3HmytqZzPhBfI5PsfSstcF5OxbATch+omabEkR0hCXmR4Dkvkor7O07VBgWPgQeCX3cfNEynTcFdnpc0Chp4oPnF9rVE1ieeYFVcH8aWD7Fgs0JkszHqimQEuiMimn/qB2cjZL2OQBtvQkLYr/H4z03DbiPBZHdLGOUtZ+CcUI7OtqSJbrJytuntKUjpcJNCZIra0VmJL0/5xF26Th7fv2tJc3wTywO4hutvPuRZv7V+7lYGlIVDxLQ9jIzqA+jfeJ7ld2sudYLbehIpWhDgsy8feb2I7r7fx0S2V2W7cwP8sHNKGmiSPaVCcZxtWU6ZwWxr5e0OwkYCCIbssxZlulcHbLOjlfXkCAJrdsbgXaLQnyx3IuVwHWV0eO5DQlilLTvAgj0my/CFMrdvBGCW1c14wVrhrMr5kCUdMrMaEyQzq5S8hLAZQYeAynrbNd+UFXVNytQDobHB5OCBZ18HoSBdSR897wHrYHhX+fKfQegqhwAhfdn0AeTOA/S7Kpnj+bZA/bqZvO66ed1CTJjcMYOVWVYHEqSQyIwigCDv2Sb7tezBEddguhFfR4Rl7MERiZiJbwAxnoCr/c8rCeFhogw5HlUIXhD1EtDXpUqCrifiWcwKYbCnGPAYHDOzrtfzQRO40HWJYhR1D4Lgmh2I0c6EagCvA6gB8jju6sePeFsdNZn9Yt40BTWv4OUtR8RQ9ZLCopsInL8a/Zwp6LQQ2qvc9+rc/FqIm50kdEGdxB1rew+m4ZMj5GCwCvFw37bHq+BPrM6s3+Yh/u9YW9Gr8r9Hvf0K1QdGnFpSOlTNvVR39DGno1DmAvxRrGrR32ClLRNAPq7Ovq0Bkd4FYwfw/NuCkIKbYW2c4/Ke7JHs0DYCcBORNiJGbN8VeUnWOzhWSKI8+vPiL8JeKZnxHnwH0fglbTCO9nvmgTZ+pfY1tW0rgiwG5I0EQPjaVb4BpByQ6OKLlvGbAwac6B4c0CYA8YcAHH0CBGbS+9i4nWs0DrncOePacxFTYJoK7XZSm/MW8PTiF5MPhPwezCuqmzn3ID9UWlmtr+s7uUxFQgwGSg0mx/Tz0cJI14YqKp7V1qej2oSRC/r7yHme2ICTpqphwCjQqB/U4fsK189vvEDt1E2Dga8k9jDPCK8o8NBfRUkyILBVkmfVDw1CWKU1A8A9LOknJJ2RbEAvoGqfOXQEcP/3QiPXFE7lgmnAvhAKnELuGyMK9aaBMmVtE8x8L24nJB2piDwCHl8cWXA/UUjXPSyfhp5fCoIh3YFfuMvHsjz/rMyMPybTomp9hKrAw5JdQpAMfvxba3XubjR+jxX1s9g4Aww7xezb7GZY+BaxfOu7QSi1FliaWIHr9jJK0c8CDS9a2SBGFtC3QlEqfcM8mGAborn2si2FVGMQe9zLqh318iVtaOZcT6Ad2cWKabLtD770iTefNV+zVvSBhTgzswmJKbAifGpSsGpWa1EH9R3AvH5RDgzJnc62gwzHodCl9p5+8Y4Ha39kD7WOuChOB3JnC1POcQasO6vFbdRGl3iirtG2xVRug9XulmB9/Uh0300jtjqPKTrO5HCz8bhQBZtWBucmVgAsZVn6lgGVd9Wu4rEQ7gc9RFgvEDEn6mYbuQ9amrvxVqBrYw+7e8yRxEgoChvtuZZf95Sszqo7tar0FUM5COw2q0q2y5q3gyYRpsVNwDYppkC+fPWEWDQXNu079pSIlfUjmLCVaINW+va5MxxBAJXjGkFwfoEKWu3gnFcK0rknBYQqFOd0Eik6nwL/qZoiigSro44p0Sxg7jRHSSRSoQpykvLrrLHp9gD7rTX5pIcLUPYfCKLJq44IuzWcQ3uIMbBYK/mW5bm3soZmxFg5i/bhennuPWS/nECXyeRChcBIu/ASn44tDew9cv+rEGvMaKJqoryOSRgDon5+krB/diW4npJvZBAXwuoVoo1QYAUb7/KvOGHwwCqWeE40VFqfhiGMqeDcY/FzlFbNp/JDWqfZiX+ZjhZw79KvIebd3/fbtwNCZJQG+J2Y+oE+VcV9uZu2bLBGFQ/CIX+qxMc7HofCMNV8D7tkqTxHSTZzlJpzuHZlulMKZk01qWLVgC0XZoDS5PvBDwxQnxCOyRp2v7AKKlrATooTcAk6ivhF1beOX6KD8sww9hGHQSROA8uR5wIiKXuq87hWIBqELNNCSKXWb5grbm00ova94nwSV+a5OTQECCixZW8fWEQhU0JknADzyAxJSkzbWmVK2qfZML3k3RK2gaIMb9ScFb4xaIpQYRCucxqAVai31h5e//JM8fL7QwCmNGCBjklWgQe1uEcvsGErz2GLRFELrOaZ46Izqzk7Wsnz9RL2h0EHNVcWs6IBQGiy6y8vdCPrZYIsm0JWzvQHmDg7X6UZ2ZurbtHSV0A0M0JYPAIAw8phEcIeJaBWQzsDA+7gHBMAv6I5U2JCY8z0W/I84aA0YqOOxOwS8y7l6sYO4fTconWlggiQM0N6mewwj9MAuBOt1nr7mEUtbvjrjhC4H9Xe91z6h1N1QY1s6cH58bZlJU9vtgecC+ql8PxLTfnAZgdS54ZP7MKzomt2mqZIGPPIproFzKvVeVZmMeMx+yCs+fUpVX8+6yaXYhTno3K2mVgiIsy0tGqT6JZbNVwl8ZHXD7ZMt2lrQTviyC5Qe1oVnB7K4qzMoeZL7QL7uIpF2BJfwjgKQ/sEePxK8t0fNXHMorabSAcG6FfvnwSBbWVXqwB4S0R+jSumtZZpn1AK3Z8EWTsLqLeAFDgvt+tOJWiOUPs0Z72gL1+s89GWT0JTD+JMYZN3gj2d470Vxx69ILsg6jaGH4Ff6YNXpUP9uuTUVSPB9EtsWBH/EEr7zZ9RvRNkP5i3z4eelaDeNtYAulgI0xYYued06fePbR4N3gy328V3EOCwGSU9AcBbuk3qT/9dLNl2qIRqa8x454Zr686w3/1JRR88h2W6RzdTNw3QcbuItpngNEjopkezJS3C/aqzSDoJf0wAq+JExRRV8suOJ8KYlMvakuIcFoQ2UYy7NEn7AE70FkXo6Q9CWCXsH2qpa/eEejJcwMRZIwk+s0AL4gjkE60UevhPFfWljCHf8E1vBglQQJfHkS4rpJ3GrYZDEwQbbU2W6lC9Mx+Y2APUyzIwA9sc9Jv7mXoMbbV/hQ7HnKJ1cZVxK/0Vd1dGp1lD0wQ4VWurJ/GzEva8DC1osz0EbvwWpU/fZV+qGgOk0BAwR7Sy9quCkOcuuuch/QE2m4w8Sl2fnq9gM15bIsgoyQpqtcz0UcTuDASNSn6+01+e6WX1C8RKKke4r5eqeI2zDRy2h0A3hMhiL58Eg2AmL2VBGwdoU81VPNNlumeUs9m2wQZA1stAvSueANL1Np6y3Sm1LAySuoDSWLQ6ke58aWx+G7z/qgRZPBFtule3MyO+MKvKKP9aN7WbG74P2+8zGqfIAC0sdv1rwDsEH4AHaiR6SdWwf7QhGf3YqZhaf/oAE/vQo+y0Dq89l4jo6ieB4XOBWP7uHwVnbI8KIts0xbPZ1OGcbfxFrie+KIv3oomOPgEy3R/XsuBUAgiFCfxijMxRInPt/LuNzfb14v6PCIW23A6ZfyKPV6t9NA6r8r7Uw+9EwzRcCeRFyoM/J0I9xBwJ3u8AQrtN+oPQfw9M2nQiOkblYL9xUgJIpQbRfVDIGppj0vSoLRj32MMOAWnOEGQsnoBMU3ZbtKOfikbLwIEFCumMxA5QcZIop0DwhXxhhivtR6tb4dNh24SNcNGh1HWbgFj6jn0eF2S1tpCgP9mmW7NZWdoS6zJ/nX5l/Y/W6bz5i3ifUH28mjrCk1c2CPMdvKO+Io/ZURCEGGhv6wd4TFWJh55+A6sskzntRYFj0M1XtSc8M1IjXEisOWyebPtyAgiDHTpg/tyy3TetxnAmeWZrxth9+U4kyltRYFA7TdZkRJkdH1eMt4F9pbFs88/CuCm3XSXWqZ98ub/q6/U30q9PLHdPQ4PpI3wEWCmj9kF+/rYlliTDfWv7tvbqyo3ANgr/NDi1cjAj2zTmWiR1l9S9/RAv4vXC2ktAgTOskzn6kQIMvpMsqZ/R69avQLME799IwgyDpXfskzn85sNiS0Ssk1EHLBHa4OJv2jn3W8kRpCJJUlJXUigaY5EG3542onoq5W8/WVJkPAw7RBN51qmM+3zROTPILWC18qaqYgDVxxTJYswM0C40so752xWOWNQfUdVoVhaEocZhtQ1FQFmOtUu2D9O/A6y2YFtbsU2zgz9BwCflKZkEfH1lfxrTXH0kv7PBH4+TTFIX6cjkMhr3lYSYZS0FwH8UytzO2IO43ar4ExUA9n6l9jW1bRXOsI36URgBBTivYfy7rSXLYkssSbW76uMN8HzxFfoNI37LNN594TDYycJR9IUgPR1OgIK9e44lB96qWOWWMKRXFm/hJkXpSlhoilLxXR2n+yzUdL+CGDXNMUhfZ2KgGU6NW8Wyd5BSpoo8fL6lCXrJct0dpxKEH0pwK+dD0lZQJl3t8G5/sQIktqHW8KwlXfUKQTJwA7mLifRFZbpnFsrxsQIkivqi5n4gjQCv+UDXZfuOUtjaoL5zPx+q+De2lEEMYr6K2mtzkiEz1TyzjUTgI4VQeiEI7fBLpCMS9V7QBewJHIH0cv6LGJ+Jr15mV5aM+miDenFMmnP+QHLdOs2V02EIEZJE+e5a675AsB1NzP+QKB9QbwvgL4AOvyKvGiZzpsmCyVc9sev/3L+awhM6ys5GZykCCKWI+0e1r+XPfqKPWCL6o4TY8ZqdY8RT9mXPN4XBEEY8WebsK+ILV8LJlg4LuzQsqTvpR6vb69NA5vqFsyOnSDjJYLEd4Ngg/h+hvIVO2+3XEVEH9R3ol5vH6oq+/LYXUZ8s9gZQE8wJwAmOtTO26LU0dhIqvRo0ACknEBgys7sWpDEThCjpF0J4Gzf+SG+X2G6ZMh0RNfYUIY47IQe7KwQZoHxFgb3MyFH4H6A+hni36NLNtFXb4iJh4hhgWExcWXLomhJFK8OBYiMKiH2DqgUhtc1Cj8JglTEQUMfObmXGN8I0uPah41QpsrXvaHAGJeSn1umc0IzY7ESRF2h7t7TR483c2r054x7SMHllbwjGtKkZhilmBvopAaZznLUUzDgzHuttlk972IliFHSvgvgrIZQEdYQ83cqpntbZ0HamjcJtGBrzTE5awKBLY9Nd8wSyyhpboPXsKug8DXWvNpfNNOUXyP+Jp5pgidhX/kVr4fmOIe31tMxtjtIveIGo03mFb7Wyrs/Sxi50MyP9/4O1IIsNCekopoIMPGFdn5qV+KOuIMYJU2Ut5/opcfAIHm8xBroHmJMBtooaneD4Ks1s7ymI0fgt1avMwdzYbdqKbY7iFHSPLG1hYEVpPCSblhKNQLZKKkLAGraZrjVRMl57SOgAEf4/UwQC0Fypb59GcolBF6S1ofvIOnRS9odBBwVRFbKhIsAgy+wTfdSv1rjIcigdkxlwLndr3Npn28M9h0EhVYAtF3aY0m3/7TMMu1AxUFiIUi6wW3Pe72snkxMN7anRUq3gcBTPEIF+0j7uSA6JEGCoOZTRh9ULyKFvuJTTE4PA4EGh6FaUS8J0gpKIcwxSuqNAKW97GoISMSngkEftU1b1IQOPCRBAkPnU3AZDGNbdQ1AB/mUlNMDIECET1byzg8DiE4RkQRpF0Ef8rli7o1MI4/Kh3YfoAWY2mpL7FZUS4K0glKIc2Qt3xDBrKWKcKuVd0LrAS8JEnG+aqnXB/VDSeG7EzDd1SaZsNLOO6F+d5IESeiSyZX7DmBWHkzIfBeanV5II4wgJUHCQDGgDr2szyXmKWfqA6rKtBgD19qmc2YUIEiCRIGqD525Vdox7GG5DxE5dTIChMutvHNeVKBIgkSFrA+9WlErKITLu6GHo4+w254adH+VH8OSIH7QinBuf7n/DR4PXw7QRyI000Wq+WTLdJdGHZAkSNQI+9RvlLQvAKN3EzlqIUB4mZmOt0373jgAkgSJA2WfNsaro4i9W4f5FO326fcx6MO2af8prkAlQeJCOoAduclxKmj1mtwEgLZlEUmQlqFKZqK8m7yGO3t8ij3g3hRnJiRB4kS7DVu5sn4GA2eAeb821KRaVBzXtk1nfpxBSILEiXYItrJOlLiXWZIgIVy0SajQi/q/AHwiUbbOvLNC77Xn2ffEhbkkSFxIR2RnfE/XiSCcCMZbIzLTMWqj3FZS+61yx4QuHWkLgUH06z3qccQ4EhB/OrhQBOFhMN4ZMN5Nlum021umZdPyDtIyVOmZuNWd2M7tVY/sELL8LwhrAV7LpKy1d7TXYg+46qC6W08PfROMY/wi6zF2dQrOU37lgsyXBAmCWppkVmArXdUPBLwDielAAOLI75Q+7+GGw2sBWgsaJ8Q8+/lG+sfOxnjf9HMUmcGLbNP9Wrh+19YmCRIHyh1mQ7tTe1tPD2Z7oB2IvR2g0A5gfgMx7cDgrRjUT4R+YNIfwkYwNgLYBKKNYN7IwJPEeJIU/LEKPOnknSeDhmoMqidAIdG7cqdmOgh4omI6uzebF8bPJUHCQFHqCA2B3KD2aVYgiCIIWndYvc5MzMWm0AzXUSQJEjXCUr9/BFZA0/vUhQS6qJ4wMZ1eKdhL/Cv3JyEJ4g8vOTtGBPSS/s8EXji5K8Bm8wSUK6ZjRu2OJEjUCEv9bSMw/q1HEGVKtZI4vqpLgrSdPqkgLgRyZe1oZgiiHCJsEnB0xXTuiNK+JEiU6ErdkSCgD+qnkSKWXvyAZbqnRmJkXKkkSJToSt3RIcAgvaReYBdab6cWxBlJkCCoSZmOQaB/Tf+OQ3OH/hKVQ5IgUSEr9XYFApIgXZFGGURUCEiCRIWs1NsVCEiCdEUaZRBRISAJEhWyUm9XICAJ0hVplEFEhYAkSFTISr1dgYAkSFekUQYRFQKSIFEhK/V2BQKSIF2RRhlEVAhIgkSFrNTbFQhIgnRFGmUQUSEgCRIVslJvVyAgCdIVaZRBRIWAJEhUyEq9XYGAJEhXpFEGERUCkiBRISv1dgUCkiBdkUYZRFQISIJEhazU2xUISIJ0RRplEFEhIAkSFbJSb1cg8P+GamNQVETlcAAAAABJRU5ErkJggg==",
"socialType": "wechat",
"socialUserId": "oDuIHs14354gjaRpvyZulyKk760Q",
"socialId": "ciammasterwechat",
"bound": true
}
],
"createTime": 1675407254000,
"picture": null,
"description": null
}
}Parameter name | Type | Example | Description |
uuid | string | xxx | User's unique identifier |
username | string | xxx | User's login account name |
externalId | string | | User's external ID |
phoneNumber | string | 1510000**** | User's phone number |
phoneRegion | string | 86 | User's phone area code |
string | test******@gmail.com | User's email | |
enDisplayName | string | | User's English display name |
displayName | string | | User's display name |
enabled | boolean | true | Whether enabled |
locked | boolean | false | Whether locked |
gender | string | Male | User's gender |
birthday | string | 2022-01-01 | User's birthday |
description | string | | User's personal description |
country | string | China | User's country |
region | string | | User's region |
province | string | | User's province |
city | string | Beijing | User's city |
street | string | | User's street |
address | string | | User's detailed address |
fullName | string | | User's full name |
picture | string | data:image/*;base64,xxxxxx | Base64 format image |
updatePasswordTime | string | 2022-01-01 00:00:00 | Password update time |
userTypeDictionaries | Array | | Current user's extension attribute list, grouped by user type |
baseAttrDictionaries | Array | | Configuration list of current user's basic attributes, including whether attributes can be modified |
userTypeDictionaries parameters
Parameter name | Type | Example | Description |
userTypeCode | string | | User type code |
userTypeUuid | string | | User type unique identifier |
userTypeName | string | | User type name |
dictionaries | Array | | List of user's extension attributes under the current type |
dictionaries.dictionaries and baseAttrDictionaries parameters
Parameter name | Type | Example | Description |
uuid | string | xxx | User's unique identifier |
fieldName | string | Department | Extension attribute field description |
fieldValue | string | department | Extension attribute field name |
dataDictionaryType | string | USER_TYPE | Object type to which the extension attribute belongs, refer to Appendix 7 |
dataDictionaryFieldType | string | DATE | Extension attribute data type, refer to Appendix 8 |
dictionaryObjectName | string | Doctor | Object name to which the extension attribute belongs |
dictionaryObjectId | string | xxxx | Object UUID to which the extension attribute belongs |
modifiable | boolean | true | Whether users are allowed to modify |
enabled | boolean | true | Whether the current extension attribute is enabled |
unique | boolean | true | Whether the extension attribute value is unique |
needShow | boolean | true | Whether visible (mainly used to control whether to display the extension attribute in the user center) |
needSensitive | boolean | true | Whether to desensitize |
remark | string | | Notes, description information of the extension attribute |
dictionaryValue | string | | Extension attribute value |
dictionaryValueUuid | string | | UUID of the extension attribute value |
selectFieldOptions | Array | | Available options for dropdown type extension attributes |
customAttributes | Array | | Available options for checkbox type extension attributes |
selectFieldOptions parameters
Parameter name | Type | Example | Description |
uuid | string | xxx | Unique identifier for radio button option |
optionId | string | 1675168417834 | Unique ID of the radio button component, mainly used for frontend id assignment |
optionLabel | string | Name | Field description for radio button component option |
optionValue | string | name | Field name for radio button component option |
customAttributes parameters
Parameter name | Type | Example | Description |
uuid | string | xxx | Unique identifier for checkbox |
attrId | string | 1675168417834 | Unique ID of the checkbox component, mainly used for frontend id assignment |
attrLabel | string | R&D Department 1 | Field description for checkbox component option |
attrValue | string | xx | Field name for checkbox component option |
3.2. Modify personal information
API endpoint
Request URI: PUT /api/bff/v1.2/developer/ciam/user/info
Content-Type: application/json
Request parameters
Parameter name | Type | Required | Description |
uuid | string | Yes | Account unique identifier |
enDisplayName | string | No | English display name |
displayName | string | No | Chinese display name |
language | string | No | Language type |
avatarUuid | string | No | Profile picture |
fullName | string | No | Name |
gender | string | No | Gender |
birthday | string | No | Birthday |
country | string | No | Country |
region | string | No | Region |
province | string | No | Province |
city | string | No | City |
street | string | No | Street |
address | string` | No | Address |
dictionaryValues | Array | No | Account extension attribute list |
dictionaryValues parameters
Parameter name | Type | Required | Description |
uuid | String | No | UUID of the extension attribute value |
dictionaryUuid | string | xxx | UUID of the extension attribute |
dictionaryValue | string | xxx | Value of the extension attribute |
Response parameters
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1661945550706$e7b5f9b7-9afc-ec94-6bff-4ce8f8a2fcff",
"data": null
}3.3. Get login history
API endpoint
Request URI: GET /api/bff/v1.2/developer/ciam/user/login/history/list
Request parameters
None
Response parameters
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655448268429$17c01a35-5c26-33b8-ba1b-d905e4d191a3",
"data": {
"historys": [
{
"uuid": "f5b1c561d9eea3ceb860ffc8cdd5d3161TyJiKV1dRC",
"createTime": "2022-06-14 21:49",
"archived": false,
"updateTime": "2022-06-14 21:49",
"loginMode": "SMS",
"loginIp": "0:0:0:0:0:0:0:1",
"loginAddress": "Unknown"
},
{
"uuid": "463e2ed871ee44bcb00240f9339680895CTp6o51XMK",
"createTime": "2022-06-14 21:42",
"archived": false,
"updateTime": "2022-06-14 21:42",
"loginMode": "SMS",
"loginIp": "0:0:0:0:0:0:0:1",
"loginAddress": "Unknown"
}
]
}
}3.4. Get privacy terms authorization history
API endpoint
Request URI: GET /api/bff/v1.2/developer/ciam/user/get_agree_records
Request parameters
None
Response parameters
{
"success": true,
"code": "Operation.Success",
"message": "Operation.Success",
"requestId": "1655448255894$c40c7299-4c67-b2a0-f06f-217cd93a616b",
"data": [{
"id": 29,
"createTime": 1656408934000,
"updatedTime": 1656408950000,
"uuid": "4fe63949bc8f45e0b01990420f2b5a1fnA182kHw1eU",
"systemId": "0000000000000000",
"tenantId": "a48708d5b95fe8f935252ddc8500254bvNEfoDffUqV",
"name": null,
"consentType": null,
"description": null,
"versionNumber": "v1.0",
"versionTitle": "Test",
"versionContentType": "TEXT",
"base64EncodeContent": "PHA+5rWL6K+V77yM5rWL6K+VLTLvvIzmtYvor5UtMjwvcD4=",
"recordVersionStatus": "PUBLISHED",
"publishDate": 1656408950000,
"expiredDate": null,
"recordUuid": "34bdf1c7cc04880730d9d4b0dc38fa467eXWh2wc8m5",
"recordExternalId": "a4a94594-528c-45e8-bde6-10a3edd4f018",
"registeredApplications": null
}]
}3.5. Revoke privacy terms authorization
API endpoint
Request URI: POST /api/bff/v1.2/developer/ciam/user/agree_records/recall
Content-Type: application/json
Request parameters
{
"uuid":"123456"
}Response parameters
None