Method: accounts.resetPassword

使用 sendOobCode 生成的非正规代码或指定要修改的账号的电子邮件地址和密码,重置账号的密码。还可以检查带外代码的用途,而无需使用该代码。

HTTP 请求

POST https://identitytoolkit.googleapis.com/v1/accounts:resetPassword

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "oobCode": string,
  "newPassword": string,
  "oldPassword": string,
  "email": string,
  "tenantId": string
}
字段
oobCode

string

由 accounts.sendOobCode 请求生成的非正规 (OOB) 代码。仅指定此参数(或仅指定此参数和租户 ID)即可在响应中获取外部代码的类型,而无需更改账号的状态。只能通过此方法使用 PASSWORD_RESET 异步代码。

newPassword

string

要为此账号设置的新密码。指定此字段将导致更改账号,并使用非正规验证码(如果指定了此类验证码且其类型为 PASSWORD_RESET)。

oldPassword

string

要修改的账号的当前密码。指定此值并发送电子邮件,即可在不使用外部代码的情况下更改账号的密码。

email

string

可选。要修改的账号的电子邮件地址。请指定此值和旧密码,以便在不使用外部代码的情况下更改账号的密码。

tenantId

string

可选。账号所属 Identity Platform 租户的租户 ID。

响应正文

针对 accounts.resetPassword 的响应消息。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "kind": string,
  "email": string,
  "newEmail": string,
  "requestType": enum (OobReqType),
  "mfaInfo": {
    object (MfaEnrollment)
  }
}
字段
kind
(deprecated)

string

email

string

与所用外部代码关联的电子邮件地址。

newEmail

string

requestType

enum (OobReqType)

mfaInfo

object (MfaEnrollment)

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview