Halaman ini diterjemahkan oleh Cloud Translation API.

Method: accounts.signInWithEmailLink

Permintaan HTTP
Isi Permintaan
- Representasi JSON
Isi respons
- Representasi JSON
Cakupan otorisasi
Cobalah!

Login atau mendaftarkan pengguna dengan kode out-of-band dari link email. Jika pengguna tidak ada dengan alamat email yang diberikan, data pengguna akan dibuat. Jika login berhasil, ID Identity Platform dan token refresh akan diterbitkan untuk pengguna yang diautentikasi.

Kunci API diperlukan dalam permintaan untuk mengidentifikasi project Google Cloud.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{ "oobCode": string, "email": string, "idToken": string, "tenantId": string }

Kolom
`oobCode`	`string` Wajib. Kode out-of-band dari link email.
`email`	`string` Wajib. Alamat email tujuan pengiriman link login. Panjang email harus kurang dari 256 karakter dan dalam format `name@domain.tld`. Email juga harus cocok dengan produksi addr-spec RFC 822.
`idToken`	`string` Token ID yang valid untuk akun Identity Platform. Jika diteruskan, permintaan ini akan menautkan alamat email ke pengguna yang diwakili oleh token ID ini dan mengaktifkan login dengan penautan email di akun untuk masa mendatang.
`tenantId`	`string` ID tenant Identity Platform tempat pengguna login. Jika tidak ditetapkan, pengguna akan login ke project Identity Platform default.

Isi respons

Pesan respons untuk accounts.signInWithEmailLink.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON

Representasi 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)
    }
  ]
}

Kolom
`kind (deprecated)`	`string` Item ini tidak digunakan lagi.
`idToken`	`string` Token ID Identity Platform untuk pengguna yang diautentikasi.
`email`	`string` Email yang digunakan pengguna untuk login. Selalu ada dalam respons.
`refreshToken`	`string` Token refresh untuk pengguna yang diautentikasi.
`expiresIn`	`string (int64 format)` Jumlah detik hingga masa berlaku token ID habis.
`localId`	`string` ID pengguna yang diautentikasi. Selalu ada dalam respons.
`isNewUser`	`boolean` Apakah pengguna yang diautentikasi dibuat oleh permintaan ini.
`mfaPendingCredential`	`string` String buram yang berfungsi sebagai bukti bahwa pengguna telah berhasil lulus pemeriksaan faktor pertama.
`mfaInfo[]`	`object (MfaEnrollment)` Info tentang penyedia autentikasi multi-faktor yang diaktifkan. Ada jika pengguna perlu menyelesaikan login menggunakan autentikasi multi-faktor.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.