Method: accounts.mfaEnrollment.start

Langkah pertama dalam proses pendaftaran MFA. Dalam kasus SMS, tindakan ini akan mengirim kode verifikasi SMS kepada pengguna.

Permintaan HTTP

POST https://identitytoolkit.googleapis.com/v2/accounts/mfaEnrollment:start

URL menggunakan sintaks gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "idToken": string,
  "tenantId": string,

  // Union field enrollment_info can be only one of the following:
  "phoneEnrollmentInfo": {
    object (StartMfaPhoneRequestInfo)
  },
  "totpEnrollmentInfo": {
    object (StartMfaTotpEnrollmentRequestInfo)
  }
  // End of list of possible types for union field enrollment_info.
}
Kolom
idToken

string

Wajib. Token ID pengguna.
tenantId

string

ID tenant Identity Platform tempat pengguna yang mendaftarkan MFA berada. Jika tidak ditetapkan, pengguna akan menjadi bagian dari project Identity Platform default.
Kolom union enrollment_info. Informasi MFA menurut jenis faktor ke-2. enrollment_info hanya ada berupa salah satu diantara berikut:
phoneEnrollmentInfo

object (StartMfaPhoneRequestInfo)

Info verifikasi untuk mengizinkan pengiriman SMS guna verifikasi telepon.
totpEnrollmentInfo

object (StartMfaTotpEnrollmentRequestInfo)

Info login khusus untuk autentikasi TOTP.

Isi respons

Respons mfaEnrollment.start.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{

  // Union field enrollment_response can be only one of the following:
  "phoneSessionInfo": {
    object (StartMfaPhoneResponseInfo)
  },
  "totpSessionInfo": {
    object (StartMfaTotpEnrollmentResponseInfo)
  }
  // End of list of possible types for union field enrollment_response.
}
Kolom
Kolom union enrollment_response. Respons pendaftaran awal MFA menurut jenis faktor ke-2. enrollment_response hanya ada berupa salah satu diantara berikut:
phoneSessionInfo

object (StartMfaPhoneResponseInfo)

Info verifikasi untuk mengizinkan pengiriman SMS guna verifikasi telepon.
totpSessionInfo

object (StartMfaTotpEnrollmentResponseInfo)

Info respons pendaftaran khusus untuk autentikasi TOTP.

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.

StartMfaTotpEnrollmentRequestInfo

Jenis ini tidak memiliki kolom.

Info permintaan MFA khusus untuk autentikasi TOTP untuk StartMfa.

StartMfaTotpEnrollmentResponseInfo

Info respons MFA khusus untuk autentikasi TOTP untuk StartMfa.

Representasi JSON 
{
  "sharedSecretKey": string,
  "verificationCodeLength": integer,
  "hashingAlgorithm": string,
  "periodSec": integer,
  "sessionInfo": string,
  "finalizeEnrollmentTime": string
}
Kolom
sharedSecretKey

string

String berenkode base 32 yang mewakili secret TOTP bersama.

Encoding base 32 adalah encoding yang ditentukan oleh RFC4648#section-6. (Ini sama dengan encoding base 32 dari RFC3548#section-5.)
verificationCodeLength

integer

Panjang kode verifikasi yang perlu dibuat.
hashingAlgorithm

string

Algoritma hashing yang digunakan untuk membuat kode verifikasi.
periodSec

integer

Durasi dalam detik saat kode verifikasi akan berubah.
sessionInfo

string

String yang dienkode yang mewakili sesi pendaftaran.
finalizeEnrollmentTime

string (Timestamp format)

Waktu pendaftaran harus selesai.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".