Customer Identity (CIAM)
Update Personal Email
This API is called when a user, after successful login, wants to modify their personal email address.
This is a post-login API, requiring the addition of authentication information in the header: Authorization
# Request Specification
POST https://{your_domain}/api/v2/sdk/profile/update-email
# 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 |
| Authorization | Authorization Information | Yes | String | Bearer {id_token} |
| content-type | Content Format Type | Yes | String | application/json |
# Request Example {/examples/}
{
"email": "15201657312@163.com",
"verify_code": "123456"
}
1
2
3
4
2
3
4
# Request Parameters {/examples/}
| Parameter Name | Chinese Name | Required | Type | Description |
|---|---|---|---|---|
| Yes | String | The new email to be updated | ||
| verify_code | Email Verification Code | Yes | String | The verification code received by the new email To get the verification code, please refer to the Send Email Verification Code API type=UPDATE_EMAIL_EMS |
# Response Example {/examples/}
Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
Error Example:
HTTP/1.1 400 Bad Request
{
"error_code": "IDAAS.SDK.PARAM.0016",
"error_msg": "IdToken is invalid or expired"
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# Response Parameters {/examples/}
None
# Error Codes {/examples/}
| Status Code | Error Code | Error Message | Remedial 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.0015 | IdToken cannot be empty | Please check if the input IdToken is empty |
| IdToken不能为空 | |||
| 400 | IDAAS.SDK.PARAM.0016 | IdToken is invalid or expired | Please retrieve a new IdToken and try again |
| IdToken无效或已过期 | |||
| 400 | IDAAS.SDK.PARAM.0009 | Verification code cannot be empty | Please check if the input verification code is empty |
| 验证码不能为空 | |||
| 400 | IDAAS.SDK.CAPTCHA.0007 | Incorrect verification code | Please check if the input verification code is correct |
| 验证码不正确 | |||
| 400 | IDAAS.SDK.USER.0021 | The e-mail does not meet the verification rules | Please check if the input email is correct |
| 邮箱不符合校验规则 | |||
| 400 | IDAAS.SDK.USER.0036 | E-mail already exists | Please use an unregistered email |
| 邮箱已存在 | |||
| 400 | IDAAS.SDK.USER.0001 | User not found | Please register first and try again |
| 用户未找到 |