Method: getRecaptchaConfig

Récupère les paramètres nécessaires à l'analyse reCAPTCHA.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
tenantId

string

Identifiant d'un locataire.

clientType

enum (ClientType)

reCAPTCHA Enterprise utilise des clés de site distinctes pour différents types de clients. Spécifiez le type de client pour obtenir la clé correspondante.

version

enum (RecaptchaVersion)

Version de reCAPTCHA.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Configuration pour reCAPTCHA

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "recaptchaEnforcementState": [
    {
      object (RecaptchaEnforcementState)
    }
  ],
  "recaptchaKey": string,
  "useSmsBotScore": boolean,
  "useSmsTollFraudProtection": boolean
}
Champs
recaptchaEnforcementState[]

object (RecaptchaEnforcementState)

État de l'application forcée de reCAPTCHA pour les fournisseurs pour lesquels GCIP est compatible avec la protection reCAPTCHA.

recaptchaKey

string

Nom de la ressource de clé reCAPTCHA Enterprise, par exemple "projects/{project}/keys/{key}". Cette valeur ne sera renvoyée que lorsque l'état d'application de reCAPTCHA est AUDIT ou ENFORCE sur au moins l'un des fournisseurs reCAPTCHA.

useSmsBotScore

boolean

Indique si le score du bot rCE doit être utilisé pour le fournisseur de téléphone reCAPTCHA.

useSmsTollFraudProtection

boolean

Indique si le score de risque de protection contre la fraude à la facturation par l'opérateur via SMS rCE doit être utilisé pour le fournisseur de téléphone reCAPTCHA.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez Authentication Overview.

RecaptchaEnforcementState

États d'application de la protection reCAPTCHA.

Représentation JSON
{
  "provider": enum (RecaptchaProvider),
  "enforcementState": enum (EnforcementState)
}
Champs
provider

enum (RecaptchaProvider)

Le fournisseur qui bénéficie de la protection reCAPTCHA.

enforcementState

enum (EnforcementState)

État de l'application forcée de reCAPTCHA pour le fournisseur.

RecaptchaProvider

Fournisseurs de GCIP compatibles avec la protection reCAPTCHA

Enums
RECAPTCHA_PROVIDER_UNSPECIFIED Fournisseur reCAPTCHA non spécifié
EMAIL_PASSWORD_PROVIDER Fournisseur de mot de passe de messagerie
PHONE_PROVIDER Fournisseur d'authentification par téléphone

EnforcementState

États d'application de la protection reCAPTCHA par fournisseur.

Enums
ENFORCEMENT_STATE_UNSPECIFIED L'état d'application n'a pas été défini.
OFF Non appliquée.
AUDIT Une évaluation reCAPTCHA est créée, mais son résultat n'est pas utilisé pour l'application.
ENFORCE Une évaluation reCAPTCHA est créée, et le résultat est utilisé pour l'application.