IDaaS Open Platform
Employee Identity (EIAM)

Password Expiration - Force Password Change via Mobile Phone Number Interface

Interface

This interface is called when a user uses an SMS verification code to change their password, triggered after calling the password login interface if the password has expired or is about to expire.

# Request Specifications

Request URL https://{your_domain}/api/v2/sdk/after-login/pwd/update-by-mobile

Request Method POST

Content Type application/json

# Request Header Parameters

Parameter Name Chinese Name Required Type Example
X-operating-sys-version Calling Party Operating System Version Yes String windows10.1.1
X-device-fingerprint Calling Party Device Fingerprint Yes String 156aysdna213sc50
X-device-ip Calling Party 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 Application Authorization ID Yes String nTo1eRIub60vPb54WeE6aojPwYwImtl4
X-state-token Temporary Token Yes String eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJqZW1...

# Request Body Example {/examples/}

{
    "verify_code": "1234",
    "new_password": "P@ssw0rd123"
}
1
2
3
4

# Request Parameters {/examples/}

Parameter Chinese Name Required Type Description
verify_code SMS Verification Code Yes String The received verification code
To obtain the verification code, please refer to the Send SMS Verification Code API
type = CHANGE_PWD_SMS
new_password New Password Yes String The new password to be set

# Response Example {/examples/}

Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
  "status": "SUCCESS",
  "expire": 43200,
  "session_token": "LGTiTNVDFPlpefV3F3Hla7RUFTqInsqa",
  "id_token": "eyJraWQiOiJrMSIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJJc3N1ZXIiLCJhdWQiOiJBdWRpZW5jZSIsImV4cCI6MTY1MzQ4NDQxMiwianRpIjoieUxSVGZXY1VkYk9PeUFpbHdZU0ZqZyIsImlhdCI6MTY1MzQ2NjQxMiwibmJmIjoxNjUzNDY2MjkyLCJzdWIiOiJzdWJqZWN0IiwiYXBpIjoie1wibmFtZVwiOlwiXCIsXCJtb2JpbGVcIjpcIis4Ni0xNTkwNzEzMjg1MlwiLFwiaWRcIjpcIjIwMjIwNDI1MTQwMTM4NTE5LUJGMUItNTI4QjA1NTFCXCIsXCJ1c2VyTmFtZVwiOlwibG91eGlcIixcImVtYWlsXCI6XCIxMUBxcS5jb21cIn0ifQ.al79knH1fKa4aT4AFr_FMjqBKu2pV_g-lKzzgHzmor5X-dHwSBUtjH38KOzjIqHvkcRMjXQuBnWmjRI7-0Djn2LuWVueaf3wRXLscCWiSDC7chjUyTRXMatYINxdvW-oSWFYGFqqbdsavLqOnvehd7ahEaTuiL9yZolvslZIkIxjxBJJu7A9Ln2sk3wf9pxXU83jIJ8ubPQBoVS-ilerTTJOKDZ9XsL2ftJsaqdTJK_mYbvKaVpLIVyHHJ2NcF6f-Al4N4kc8cgxtSgSKFDcR7Bz7dYlOcfUXCPAzJ3NZInm8UaksiWU02tvlvTRvRdoxZNnvD5vamZ5hjFc-cW5jA"
}
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
10
11
12
13
14
15

# Return Parameters

Parameter Name Chinese Name Type Description
status Return Result String Possible values for this field are as follows
SUCCESS Login Successful
expire session_token Validity Period Number The validity period of the session_token, within which the 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 an sso_ticket. The sso_ticket can be exchanged for user information
id_token Short-term valid, interface call credential String This field is a JWT, containing user information and the application's scope information, which needs to be obtained after signature verification. It is valid for 2 hours by default and supports configuration

Force Password Update by Email When Expired