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 评估，并使用结果进行强制执行。