Method: getRecaptchaConfig

Obtiene los parámetros necesarios para el análisis de reCAPTCHA.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
tenantId

string

Es el ID de un grupo de usuarios.
clientType

enum (ClientType)

reCAPTCHA Enterprise usa claves de sitio independientes para diferentes tipos de clientes. Especifica el tipo de cliente para obtener la clave correspondiente.
version

enum (RecaptchaVersion)

La versión de reCAPTCHA.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Configuración de reCAPTCHA

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "recaptchaEnforcementState": [
    {
      object (RecaptchaEnforcementState)
    }
  ],
  "recaptchaKey": string,
  "useSmsBotScore": boolean,
  "useSmsTollFraudProtection": boolean
}
Campos
recaptchaEnforcementState[]

object (RecaptchaEnforcementState)

Es el estado de aplicación forzosa de reCAPTCHA para los proveedores que admiten la protección de reCAPTCHA en GCIP.
recaptchaKey

string

Es el nombre del recurso de la clave de reCAPTCHA Enterprise, p.ej., "projects/{project}/keys/{key}". Solo se mostrará cuando el estado de aplicación de reCAPTCHA sea AUDIT o ENFORCE en al menos uno de los proveedores de reCAPTCHA.
useSmsBotScore

boolean

Indica si se debe usar la puntuación de bot de rCE para el proveedor de telefonía de reCAPTCHA.
useSmsTollFraudProtection

boolean

Indica si se debe usar la puntuación de riesgo de protección contra el fraude de cargos telefónicos por SMS de rCE para el proveedor de telefonía de reCAPTCHA.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

RecaptchaEnforcementState

Estados de aplicación para la protección de reCAPTCHA

Representación JSON 
{
  "provider": enum (RecaptchaProvider),
  "enforcementState": enum (EnforcementState)
}
Campos
provider

enum (RecaptchaProvider)

El proveedor que tiene protección de reCAPTCHA.
enforcementState

enum (EnforcementState)

Es el estado de aplicación forzosa de reCAPTCHA para el proveedor.

RecaptchaProvider

Los proveedores de GCIP que admiten la protección de reCAPTCHA

Enums
RECAPTCHA_PROVIDER_UNSPECIFIED No se especificó el proveedor de reCAPTCHA
EMAIL_PASSWORD_PROVIDER Proveedor de contraseñas de correo electrónico
PHONE_PROVIDER Proveedor de autenticación telefónica

EnforcementState

Estados de aplicación forzosa para la protección de reCAPTCHA por proveedor

Enums
ENFORCEMENT_STATE_UNSPECIFIED No se estableció el estado de aplicación forzosa.
OFF No se aplica.
AUDIT Se crea la evaluación de reCAPTCHA, pero el resultado no se usa para aplicarla.
ENFORCE Se crea la evaluación de reCAPTCHA y se usa el resultado para aplicarla.