Method: accounts.resetPassword

sendOobCode によって生成された帯域外のコードを使用するか、変更するアカウントのメールアドレスとパスワードを指定して、アカウントのパスワードをリセットします。また、アウトオブバンド コードを使用せずに、その目的を確認することもできます。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

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 をご覧ください。