重置用户密码

权限

身份管理API是以应用维度授权的，在调用接口前需为不同的应用设置接口权限，详情请参考API权限。

权限代码	描述
user_all	用户管理接口的读写权限
all	全部接口读写权限

请求说明

PUT https://{your_domain}/api/v2/tenant/users/{user_id}/rest-password?send_mode=EMAIL

请求头

参数名	中文名称	必须	类型	描述
Authorization	授权	是	String	格式：Bearer {access_token}
Content-Type	内容类型	是	String	固定值：application/json; charset=utf-8

请求示例

无

请求参数

参数名	中文名称	必须	类型	描述
user_id	用户ID	是	String	目标用户ID
send_mode	新密码通知方式	是	String	固定值(SMS,EMAIL)

返回示例

正确示例：
HTTP/1.1 200 OK
Content-Type: application/json
{
  "user_id": "20201028102749564-9082-DC8CD2722"
}

错误示例：
{
  "error_msg": "用户不存在",
  "error_code": "USER.0001"
}

返回参数

参数名	中文名称	类型	描述
user_id	用户ID	String	目标用户ID

错误码

状态码	错误码	错误信息	处理措施
400	USER.0001	用户不存在	请检查对应用户是否存在
		User does not exist
400	USER.0011	手机号不能为空	请检查入参中的手机号字段是否为空
		Mobile number cannot be empty
400	USER.0012	邮箱不能为空	请检查入参中的邮箱字段是否为空
		Email cannot be empty
400	MSG.0001	消息发送失败	消息发送失败，请检查消息网关配置
		Message sending failed
400	MSG.0004	消息发送方式不符合校验规则	请检查入参中的消息发送方式是否符合校验规则
		The message sending mode does not meet the verification rules