Method: getRecaptchaConfig

Mendapatkan parameter yang diperlukan untuk analisis reCAPTCHA.

Permintaan HTTP

GET https://identitytoolkit.googleapis.com/v2/recaptchaConfig

URL menggunakan sintaks gRPC Transcoding.

Parameter kueri

Parameter
tenantId

string

ID tenant.

clientType

enum (ClientType)

reCAPTCHA Enterprise menggunakan kunci situs terpisah untuk berbagai jenis klien. Tentukan jenis klien untuk mendapatkan kunci yang sesuai.

version

enum (RecaptchaVersion)

Versi reCAPTCHA.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Konfigurasi untuk reCAPTCHA

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "recaptchaEnforcementState": [
    {
      object (RecaptchaEnforcementState)
    }
  ],
  "recaptchaKey": string,
  "useSmsBotScore": boolean,
  "useSmsTollFraudProtection": boolean
}
Kolom
recaptchaEnforcementState[]

object (RecaptchaEnforcementState)

Status penerapan reCAPTCHA untuk penyedia yang didukung perlindungan reCAPTCHA oleh GCIP.

recaptchaKey

string

Nama resource kunci reCAPTCHA Enterprise, misalnya "projects/{project}/keys/{key}". Ini hanya akan ditampilkan jika status penerapan reCAPTCHA adalah AUDIT atau ENFORCE di setidaknya salah satu penyedia reCAPTCHA.

useSmsBotScore

boolean

Apakah akan menggunakan skor bot rCE untuk penyedia telepon reCAPTCHA.

useSmsTollFraudProtection

boolean

Apakah akan menggunakan skor risiko perlindungan terhadap penipuan pulsa SMS rCE untuk penyedia telepon reCAPTCHA.

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.

RecaptchaEnforcementState

Status penerapan untuk perlindungan reCAPTCHA.

Representasi JSON
{
  "provider": enum (RecaptchaProvider),
  "enforcementState": enum (EnforcementState)
}
Kolom
provider

enum (RecaptchaProvider)

Penyedia yang memiliki perlindungan reCAPTCHA.

enforcementState

enum (EnforcementState)

Status penerapan reCAPTCHA untuk penyedia.

RecaptchaProvider

Penyedia GCIP yang mendukung perlindungan reCAPTCHA.

Enum
RECAPTCHA_PROVIDER_UNSPECIFIED Penyedia reCAPTCHA tidak ditentukan
EMAIL_PASSWORD_PROVIDER Penyedia sandi email
PHONE_PROVIDER Penyedia auth ponsel

EnforcementState

Status penerapan untuk perlindungan reCAPTCHA per penyedia.

Enum
ENFORCEMENT_STATE_UNSPECIFIED Status penegakan belum ditetapkan.
OFF Tidak diterapkan.
AUDIT Penilaian reCAPTCHA dibuat, hasilnya tidak digunakan untuk diterapkan.
ENFORCE Penilaian reCAPTCHA dibuat, hasilnya digunakan untuk diterapkan.