IDaaS Open Platform
Customer Identity (CIAM)

Skip Forced Password Change

When calling the username and password login interface, if the password is about to expire and the user chooses to skip the password change, call this interface.

# Request Description

GET https://{your_domain}/api/v2/sdk/pwd/skip-update

# Request Headers

Parameter Name Chinese Name Required Type Example
X-operating-sys-version Calling Client Operating System 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
X-state-token Temporary Token Yes String eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJqZWN0Ijoie1
content-type Content Format Type Yes String application/json

# Request Example

None

# Request Parameters

None

# Response Example

Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
    "status": "SUCCESS",
    "expire": 43200,
    "session_token": "LGTiTNVDFPlpefV3F3Hla7RUFTqInsqa",
    "id_token": "eyJ0NiJ9.eyJ1cI6IjIifX0.DeWt4QuZXso"
}

Error Example:
HTTP/1.1 400 Bad Request
{
    "error_code": "IDAAS.SDK.PARAM.0014",
    "error_msg": "Invalid state token"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# Response Parameters

Parameter Chinese Name Type Description
status Return Result String Possible values for this field are:
SUCCESS Login successful
ACCESS_DENIED Access denied
expire session_token Validity Period Number session_token validity period; ticket can be obtained using session_token within the validity period
session_token User session_token String User session_token; this token can be used to call IDaaS APIs to obtain sso_ticket, which can be exchanged for user information
id_token Short-term valid, API call token String This field is in JWT format and contains user identity information. Refer to Get User Information from id_token to obtain user information. The token validity period defaults to 5 minutes and is configurable.

# Error Codes

Status Code Error Code Error Message Handling 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.0013 State token cannot be empty Please check if the input temporary token is empty
临时令牌不能为空
400 IDAAS.SDK.PARAM.0014 Invalid state token Please check if the input temporary token is correct
临时令牌无效
400 IDAAS.SDK.USER.0001 User not found Please register first and try again
用户未找到
400 IDAAS.SDK.USER.0039 User is disabled Please contact the administrator
用户已被禁用

Overview