文档首页/ 应用身份管理服务 OneAccess/ API参考/ API/ 用户类接口/ 密码管理/ 密码过期强制修改密码
更新时间：2024-01-19 GMT+08:00
查看PDF
分享

密码过期强制修改密码

功能介绍

调用密码登录相关接口时，如果密码已过期或者密码快过期，并且用户选择修改密码时调用本接口，需要传入对应的state_token。

URI

POST /api/v2/sdk/pwd/update

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

该字段内容填为“application/json;charset=utf8”。

X-operating-sys-version

是

String

调用方操作系统版本，例如：Android 10。

X-device-fingerprint

是

String

调用方设备指纹，例如：156aysdna213sc50。

X-device-ip

否

String

调用方IP，例如：10.10.10.1。

X-agent

是

String

用户Agent信息，例如：Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36。

X-L

否

String

用于国际化语言设置，例如：zh。

X-client-id

是

String

应用标识，注册应用后分配的ClientId。

X-state-token

是

String

临时令牌，调用密码登录相关接口，密码快过期或已过期时返回的state_token。

X-tenant-id

否

String

租户id，ISV应用调用则为必填，需要将{domain_name}换成ISV通用域名{common_domain}，请求Header参数中需要指定对应租户的tenant_id，并将X-client-id换成ISV应用模板的client_id。
表2 请求Body参数

参数

是否必选

参数类型

描述

old_password

是

String

用户的原密码。

new_password

是

String

设置的新密码。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

status

String

登录流程状态标识。

枚举值：

  • SUCCESS：登录成功

  • ACCESS_DENIED：拒绝访问

session_token

String

用户session_token，可使用该token调用单点登录接口获取sso_ticket，通过sso_ticket可以获取用户信息。

id_token

String

本质上是一个JWT Token，包含了用户身份信息，默认2小时有效，支持可配置。

expire

Integer

session_token有效期，单位为秒，有效期内可以使用session_token获取ticket。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误详情。

请求示例

密码过期强制修改密码。

POST https://{domain_name}/api/v2/sdk/pwd/update

X-operating-sys-version: Android 10
X-device-fingerprint: 156aysdna213sac
X-device-ip: 10.10.10.1
X-agent: Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36
X-L: zh
X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm
X-state-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21

{
  "old_password": "P******d",
  "new_password": "P******3"
}

响应示例

状态码： 200

请求成功。

{
  "status" : "SUCCESS",
  "expire" : 43200,
  "session_token" : "LGT******sqa"
}

状态码

状态码

描述

200

请求成功。

400

参数无效。

错误码

请参见错误码。

父主题： 密码管理

相关文档