本頁面由 Cloud Translation API 翻譯而成。

Method: accounts.signInWithEmailLink

HTTP 要求
要求主體
- JSON 表示法
回應主體
- JSON 表示法
授權範圍
試試看！

使用電子郵件連結中的額外代碼，為使用者登入或註冊。如果系統找不到使用者所提供的電子郵件地址，就會建立使用者記錄。如果登入成功，系統會為已驗證的使用者發出 Identity Platform ID 和更新權杖。

如要識別 Google Cloud 專案，請在要求中提供 API 金鑰。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體包含下列結構的資料：

JSON 表示法
{ "oobCode": string, "email": string, "idToken": string, "tenantId": string }

欄位
`oobCode`	`string` 這是必要旗標，電子郵件連結中的額外程式碼。
`email`	`string` 這是必要旗標，系統傳送登入連結的電子郵件地址。電子郵件長度不得超過 256 個半形字元，格式為 `name@domain.tld`。電子郵件也應符合 RFC 822 的 addr-spec 產生方式。
`idToken`	`string` Identity Platform 帳戶的有效 ID 權杖。如果通過，這項要求會將電子郵件地址連結至由此 ID 權杖代表的使用者，並在日後啟用帳戶的電子郵件連結登入功能。
`tenantId`	`string` 使用者要登入的 Identity Platform 租用戶 ID。如果未設定，使用者會登入預設的 Identity Platform 專案。

回應主體

accounts.signInWithEmailLink 的回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法

JSON 表示法
{ "kind": string, "idToken": string, "email": string, "refreshToken": string, "expiresIn": string, "localId": string, "isNewUser": boolean, "mfaPendingCredential": string, "mfaInfo": [ { object (`MfaEnrollment`) } ] }

{
  "kind": string,
  "idToken": string,
  "email": string,
  "refreshToken": string,
  "expiresIn": string,
  "localId": string,
  "isNewUser": boolean,
  "mfaPendingCredential": string,
  "mfaInfo": [
    {
      object (MfaEnrollment)
    }
  ]
}

欄位
`kind (deprecated)`	`string` 這個項目已遭淘汰！
`idToken`	`string` 經過驗證的使用者所需的 Identity Platform ID 權杖。
`email`	`string` 使用者用來登入的電子郵件地址。回應中一律會出現。
`refreshToken`	`string` 已驗證使用者的權杖重新整理。
`expiresIn`	`string (int64 format)` ID 權杖到期前的秒數。
`localId`	`string` 已驗證使用者的 ID。回應中一律會出現。
`isNewUser`	`boolean` 系統是否已透過這項要求建立已驗證的使用者。
`mfaPendingCredential`	`string` 不透明字串，可做為使用者已成功通過第一個因素檢查的證明。
`mfaInfo[]`	`object (MfaEnrollment)` 已啟用的多重驗證服務供應商資訊。如果使用者需要使用多重驗證功能完成登入程序，就會顯示這項屬性。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱 Authentication Overview。