Method: getRecaptchaConfig

reCAPTCHA 分析に必要なパラメータを取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
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}"）。これは、少なくとも 1 つの reCAPTCHA プロバイダで reCAPTCHA の適用ステータスが AUDIT または ENFORCE の場合にのみ返されます。
useSmsBotScore

boolean

reCAPTCHA 電話プロバイダに rCE bot スコアを使用するかどうか。
useSmsTollFraudProtection

boolean

reCAPTCHA の電話プロバイダに rCE SMS 通信不正利用防止リスクスコアを使用するかどうか。

認可スコープ

以下のいずれかの 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 評価が作成され、その結果が適用に使用されます。