使用 sendOobCode 產生的額外代碼,或指定要修改的帳戶電子郵件和密碼,重設帳戶密碼。也可以在不使用外部程式碼的情況下,查看其用途。
HTTP 要求
POST https://identitytoolkit.googleapis.com/v1/accounts:resetPassword
這個網址使用 gRPC 轉碼語法。
要求主體
要求主體包含下列結構的資料:
JSON 表示法 |
---|
{ "oobCode": string, "newPassword": string, "oldPassword": string, "email": string, "tenantId": string } |
欄位 | |
---|---|
oobCode |
由 accounts.sendOobCode 要求產生的非頻道 (OOB) 代碼。只要指定這個參數 (或只指定這個參數和租用戶 ID),即可在回應中取得非頻道外程式碼的類型,而不會變更帳戶狀態。這個方法只能用來使用 PASSWORD_RESET 外部代碼。 |
newPassword |
要為這個帳戶設定的新密碼。指定這個欄位會導致帳戶變更,並使用非頻道代碼 (如果指定了 PASSWORD_RESET 類型的代碼)。 |
oldPassword |
要修改的帳戶目前密碼。指定這個值和電子郵件地址,即可變更帳戶密碼,而不需要使用額外的驗證碼。 |
email |
(非必要) 要修改的帳戶電子郵件地址。請指定這項資訊和舊密碼,即可變更帳戶密碼,而無須使用額外驗證碼。 |
tenantId |
(非必要) 帳戶所屬 Identity Platform 租戶的租戶 ID。 |
回應主體
accounts.resetPassword 的回應訊息。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{ "kind": string, "email": string, "newEmail": string, "requestType": enum ( |
欄位 | |
---|---|
kind |
|
email |
與所用外部驗證碼相關聯的電子郵件地址。 |
newEmail |
|
requestType |
|
mfaInfo |
|
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/identitytoolkit
https://www.googleapis.com/auth/cloud-platform
詳情請參閱 Authentication Overview。