ResetPassword - 重置密码--云身份中心-火山引擎

文档中心

导航

ResetPassword - 重置密码

最近更新时间：2025.03.21 11:10:03首次发布时间：2025.03.21 11:10:03

重置密码

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ResetPassword	要执行的操作，取值：ResetPassword。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
UserId	String	是	1	用户 id
Password	String	否	xxx	密码长度8-32位字符,包含大写字母、小写字母、数字和物特殊符号至少3种。当 GenerateRandomPassword 取值为 false 时，本参数必须传。
PasswordResetRequired	Boolean	是	true	首次登陆需不需要重置密码
GenerateRandomPassword	Boolean	是	false	是否自动生成密码

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Password	String	xxxx	密码

请求示例

POST /?Action=ResetPassword&Version=2023-01-01 HTTP/1.1
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250309T150549Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250309/cn-beijing/cloudidentity/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "UserId": "e",
  "Password": "YxEnyCpX",
  "PasswordResetRequired": true,
  "GenerateRandomPassword": true
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250309230554002157112024394E7C",
    "Action": "ResetPassword",
    "Version": "2023-01-01",
    "Service": "cloudidentity",
    "Region": "cn-beijing"
  },
  "Result": {
    "Password": "Ya7mu"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ConcurrentException	Concurrent request exception	存在请求并发冲突
400	InvalidParam	The parameter %v[%v] is invalid	无效参数
400	PermissionError	No permission to perform action[%s] on resource %s	没有接口权限
400	ServiceStatusException	Can not perform action[%s] when service is %s	企业身份中心实例不可用
400	PasswordLoginNotEnable	password login not enable	密码登录未开启
400	UserLoginProfileRecordExist	user login profile record exist	用户登录配置已存在
404	UserNotFound	User is not found	用户不存在
500	InternalError	Unknown internal error: %v	服务内部错误