Force Password Update When Expired API

When calling the username/password login API, if the password has expired or is about to expire and the user chooses to change the password, call this API.

Request Description

Request Headers

Parameter Name	Name	Required	Type	Description
X-operating-sys-version	Caller operating system 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	Used 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 Example

{
    "old_password": "P@ssw0rd",
    "new_password": "P@ssw0rd123"
}

Request Parameters

Parameter Name	Name	Required	Type	Description
old_password	Old password	Yes	String	User's old password
new_password	New password	Yes	String	New password to set

Response Example

Error Example

HTTP/1.1 400 Bad Request

{
    "error_code": "SDK.COMMON.1001",
    "error_msg": "Parameter X-client-id cannot be left blank."
}

Response Parameters

Parameter Name	Name	Type	Description
status	Return result	String	Possible values for this field SUCCESS = Login successful MFA_AUTH = Secondary authentication ACCESS_DENIED = Access denied
expire	session_token validity period	Number	Validity period of session_token; within this period, session_token can be used to obtain a ticket
session_token	User session_token	String	User session_token; this token can be used to call BambooCloud IDaaS APIs to obtain a sso_ticket, which can be exchanged for user information
state_token	User state token	String	Token carrying user state
data	Response description	String	Response description status = MFA_AUTH, returns secondary authentication methods status = ACCESS_DENIED, returns access denied
id_token	Short-term valid interface call credential	String	This field is a JWT containing user information and the application's scope information; it must be verified and parsed. Default validity is 2 hours and is configurable