IDaaS Open Platform
Employee Identity (EIAM)

Password Reset via Email API

API

When a user clicks "Forgot Password" on the login page and chooses to reset via email, they need to input their email, verification code, and new password, and pass the CAPTCHA verification before calling this API. After a successful call, they need to return to the login page to log in again.

# Request Specifications

Request URL https://{your_domain}/api/v2/sdk/pwd/update-by-email

Request Method POST

Content-Type application/json

# Request Header Parameters

Parameter Chinese Name Required Type Example
X-operating-sys-version Caller OS Version Yes String windows10.1.1
X-device-fingerprint Caller Device Fingerprint Yes String 156aysdna213sc50
X-device-ip Caller 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) AppleWebKit/605.1.15(KHTML, like Gecko)
Mobile/15E148/HuaWei-AnyOffice/2.6.1802.0010/com.huawei.cloudlink.workplace
X-L For Internationalization Language Setting No String zh
X-client-id App Authorization ID Yes String nTo1eRIub60vPb54WeE6aojPwYwImtl4

# Request Body Example

{
    "email": "asdas@bamboocloud.cn",
    "verify_code": "123456",
    "password": "P@sdsdfsdfds"
}
1
2
3
4
5

# Request Parameters

Parameter Chinese Name Required Type Description
email Email Address Yes String The email address receiving the verification code
verify_code Email Verification Code Yes String The received verification code
To get the verification code, please refer to the Send Email Verification Code API
type = CHANGE_PWD_EMS
password Password Yes String The new password to be set

# Response Example

Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
Error Example:
HTTP/1.1 400 Bad Request
{
    "error_code": "SDK.COMMON.1001",
    "error_msg": "Parameter X-client-id cannot be left blank."
}
1
2
3
4
5
6
7
8
9

# Response Parameters

None

Mobile + SMS Verification Code MFA