文档

ResetUserPassword - 重置便捷用户账号的密码

调用ResetUserPassword重置便捷用户的密码,包括生成重置密码Token,并发送重置密码邮件到便捷用户的邮箱。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Usersarray

要重置密码的便捷用户的用户名列表。

string

要重置密码的便捷用户的用户名。

test1
NotifyTypeinteger

重置密码后通知用户的方式。

说明 国际站账号不支持通过短信通知用户的方式。
枚举值:
  • 1通过邮箱通知用户
  • 2通过短信通知用户
  • 3邮箱和短信都发送通知
1

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

32D05B39-E6EE-4D7A-9FD0-762A26859D0D
ResetUsersResultobject

重置便捷用户密码操作的结果。

ResetUsersarray

已发送重置密码邮件的便捷用户。

string

已发送重置密码邮件的便捷用户。

test1
FailedUsersobject []

重置密码失败的便捷用户信息集合。

EndUserIdstring

重置密码失败的便捷用户。

test123
ErrorCodestring

错误码。

InvalidUsername
ErrorMessagestring

错误信息。

test123 is an invalid username.

示例

正常返回示例

JSON格式

{
  "RequestId": "32D05B39-E6EE-4D7A-9FD0-762A26859D0D",
  "ResetUsersResult": {
    "ResetUsers": [
      "test1"
    ],
    "FailedUsers": [
      {
        "EndUserId": "test123",
        "ErrorCode": "InvalidUsername",
        "ErrorMessage": "test123 is an invalid username."
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (0)