Method: getRecaptchaConfig

取得 reCAPTCHA 分析所需的參數。

HTTP 要求

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

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

查詢參數

參數
tenantId

string

租戶的 ID。
clientType

enum (ClientType)

reCAPTCHA Enterprise 會為不同用戶端類型使用不同的網站金鑰。指定用戶端類型，以取得對應的鍵。
version

enum (RecaptchaVersion)

reCAPTCHA 版本。

要求主體

要求主體必須為空白。

回應主體

reCAPTCHA 設定

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

JSON 表示法 
{
  "recaptchaEnforcementState": [
    {
      object (RecaptchaEnforcementState)
    }
  ],
  "recaptchaKey": string,
  "useSmsBotScore": boolean,
  "useSmsTollFraudProtection": boolean
}
欄位
recaptchaEnforcementState[]

object (RecaptchaEnforcementState)

GCIP 支援 reCAPTCHA 保護的提供者 reCAPTCHA 強制執行狀態。
recaptchaKey

string

reCAPTCHA Enterprise 金鑰資源名稱，例如「projects/{project}/keys/{key}」。只有在至少一個 reCAPTCHA 供應商的 reCAPTCHA 強制執行狀態為「稽核」或「強制執行」時，系統才會傳回這個值。
useSmsBotScore

boolean

是否要為 reCAPTCHA 電話服務供應商使用 rCE 機器人分數。
useSmsTollFraudProtection

boolean

是否要為 reCAPTCHA 電話供應商使用 rCE 簡訊費用詐欺防護風險分數。

授權範圍

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

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

詳情請參閱 Authentication Overview。

RecaptchaEnforcementState

reCAPTCHA 防護機制的強制執行狀態。

JSON 表示法 
{
  "provider": enum (RecaptchaProvider),
  "enforcementState": enum (EnforcementState)
}
欄位
provider

enum (RecaptchaProvider)

提供 reCAPTCHA 保護的供應商。
enforcementState

enum (EnforcementState)

提供者的 reCAPTCHA 強制執行狀態。

RecaptchaProvider

支援 reCAPTCHA 防護機制的 GCIP 供應商。

列舉
RECAPTCHA_PROVIDER_UNSPECIFIED 未指定 reCAPTCHA 供應商
EMAIL_PASSWORD_PROVIDER 電子郵件密碼供應者
PHONE_PROVIDER 電話驗證服務供應器

EnforcementState

每個提供者的 reCAPTCHA 保護措施強制執行狀態。

列舉
ENFORCEMENT_STATE_UNSPECIFIED 未設定強制執行狀態。
OFF 未強制執行。
AUDIT 建立 reCAPTCHA 評估，但不會使用結果強制執行。
ENFORCE 建立 reCAPTCHA 評估，並使用結果強制執行。