Method: projects.tenants.accounts.sendOobCode

Mengirim kode konfirmasi di luar band untuk akun. Permintaan dari permintaan yang diautentikasi dapat secara opsional menampilkan link yang menyertakan kode OOB, bukan mengirimkannya.

Permintaan HTTP

POST https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:sendOobCode

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
targetProjectId

string

Project ID project Identity Platform tempat akun berada. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai.

Otorisasi memerlukan izin IAM berikut pada resource targetProjectId yang ditentukan:

  • firebaseauth.users.sendEmail
tenantId

string

ID tenant tenant Identity Platform tempat akun berada.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "requestType": enum (OobReqType),
  "email": string,
  "challenge": string,
  "captchaResp": string,
  "userIp": string,
  "newEmail": string,
  "idToken": string,
  "continueUrl": string,
  "iOSBundleId": string,
  "iOSAppStoreId": string,
  "androidPackageName": string,
  "androidInstallApp": boolean,
  "androidMinimumVersion": string,
  "canHandleCodeInApp": boolean,
  "dynamicLinkDomain": string,
  "returnOobLink": boolean,
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion),
  "linkDomain": string
}
Kolom
requestType

enum (OobReqType)

Wajib. Jenis kode out-of-band (OOB) yang akan dikirim. Bergantung pada nilai ini, kolom lain dalam permintaan ini akan diperlukan dan/atau memiliki arti yang berbeda. Ada 4 kode OOB berbeda yang dapat dikirim: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL
email

string

Alamat email akun yang akan menerima kode OOB, dan umumnya alamat email akun yang perlu diperbarui. Wajib ada untuk PASSWORD_RESET, EMAIL_SIGNIN, dan VERIFY_EMAIL. Hanya diperlukan untuk permintaan VERIFY_AND_CHANGE_EMAIL jika returnOobLink ditetapkan ke benar. Dalam hal ini, email tersebut adalah email asli pengguna.
challenge
(deprecated)

string
captchaResp

string

Untuk permintaan PASSWORD_RESET, respons reCaptcha diperlukan saat sistem mendeteksi kemungkinan aktivitas penyalahgunaan. Dalam kasus tersebut, ini adalah respons dari tantangan reCaptcha yang digunakan untuk memverifikasi pemanggil.
userIp

string

Alamat IP pemanggil. Hanya diperlukan untuk permintaan PASSWORD_RESET.
newEmail

string

Alamat email yang akan digunakan untuk akun. Hanya diperlukan untuk permintaan VERIFY_AND_CHANGE_EMAIL.
idToken

string

Token ID untuk akun. Ini diperlukan untuk permintaan VERIFY_AND_CHANGE_EMAIL dan VERIFY_EMAIL, kecuali jika returnOobLink ditetapkan ke benar.
continueUrl

string

URL untuk melanjutkan setelah pengguna mengklik link yang dikirim dalam email. Ini adalah URL yang akan memungkinkan widget web menangani kode OOB.
iOSBundleId

string

Jika aplikasi iOS terkait dapat menangani kode OOB, ID paket iOS aplikasi ini. Tindakan ini akan memungkinkan aplikasi yang benar untuk terbuka jika sudah diinstal.
iOSAppStoreId

string

Jika aplikasi iOS terkait dapat menangani kode OOB, ID App Store aplikasi ini. Tindakan ini akan memungkinkan App Store membuka aplikasi yang benar jika aplikasi belum diinstal.
androidPackageName

string

Jika aplikasi Android terkait dapat menangani kode OOB, nama paket Android dari aplikasi Android yang akan menangani callback saat kode OOB ini digunakan. Tindakan ini akan memungkinkan aplikasi yang benar untuk dibuka jika sudah diinstal, atau memungkinkan Google Play Store membuka aplikasi yang benar jika belum diinstal.
androidInstallApp

boolean

Jika aplikasi Android terkait dapat menangani kode OOB, apakah akan menginstal aplikasi Android di perangkat tempat link dibuka atau tidak jika aplikasi belum diinstal.
androidMinimumVersion

string

Jika aplikasi Android terkait dapat menangani kode OOB, versi minimum aplikasi. Jika versi di perangkat lebih rendah dari versi ini, pengguna akan diarahkan ke Google Play Store untuk mengupgrade aplikasi.
canHandleCodeInApp

boolean

Jika disetel ke benar (true), link kode OOB akan dikirim sebagai Link Universal atau Link Aplikasi Android dan akan dibuka oleh aplikasi yang sesuai jika sudah terinstal. Jika tidak ditetapkan, atau ditetapkan ke salah, kode OOB akan dikirim ke widget web terlebih dahulu, lalu akan dialihkan ke aplikasi jika diinstal.
clientType

enum (ClientType)

Jenis klien: web, Android, atau iOS. Wajib diisi saat perlindungan reCAPTCHA Enterprise diaktifkan.
recaptchaVersion

enum (RecaptchaVersion)

Versi reCAPTCHA dari token reCAPTCHA di captchaResponse.

Isi respons

Jika berhasil, isi respons akan berisi instance GetOobCodeResponse.

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.