Method: getRecaptchaConfig

Ruft Parameter ab, die für die reCAPTCHA-Analyse erforderlich sind.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
tenantId

string

Die ID eines Mandanten.
clientType

enum (ClientType)

reCAPTCHA Enterprise verwendet separate Websiteschlüssel für verschiedene Clienttypen. Geben Sie den Clienttyp an, um den entsprechenden Schlüssel abzurufen.
version

enum (RecaptchaVersion)

Die reCAPTCHA-Version.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Konfiguration für reCAPTCHA

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "recaptchaEnforcementState": [
    {
      object (RecaptchaEnforcementState)
    }
  ],
  "recaptchaKey": string,
  "useSmsBotScore": boolean,
  "useSmsTollFraudProtection": boolean
}
Felder
recaptchaEnforcementState[]

object (RecaptchaEnforcementState)

Der Status der reCAPTCHA-Erzwingung für die Anbieter, für die GCIP den reCAPTCHA-Schutz unterstützt.
recaptchaKey

string

Der Name der reCAPTCHA Enterprise-Schlüsselressource, z.B. „projects/{project}/keys/{key}“. Dieser Wert wird nur zurückgegeben, wenn der Status der reCAPTCHA-Durchsetzung für mindestens einen der reCAPTCHA-Anbieter „AUDIT“ oder „ENFORCE“ ist.
useSmsBotScore

boolean

Gibt an, ob der rCE-Bot-Score für den reCAPTCHA-Telefonanbieter verwendet werden soll.
useSmsTollFraudProtection

boolean

Ob der Risikowert für den SMS-Gebührenbetrugsschutz von reCAPTCHA für den Telefonanbieter verwendet werden soll.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

RecaptchaEnforcementState

Erzwingungsstatus für den reCAPTCHA-Schutz

JSON-Darstellung 
{
  "provider": enum (RecaptchaProvider),
  "enforcementState": enum (EnforcementState)
}
Felder
provider

enum (RecaptchaProvider)

Der Anbieter, der reCAPTCHA-Schutz verwendet.
enforcementState

enum (EnforcementState)

Der Status der reCAPTCHA-Erzwingung für den Anbieter.

RecaptchaProvider

Die GCIP-Anbieter, die den reCAPTCHA-Schutz unterstützen.

Enums
RECAPTCHA_PROVIDER_UNSPECIFIED reCAPTCHA-Anbieter nicht angegeben
EMAIL_PASSWORD_PROVIDER E-Mail-Passwortanbieter
PHONE_PROVIDER Anbieter der Telefonauthentifizierung

EnforcementState

Erzwingungsstatus für den reCAPTCHA-Schutz pro Anbieter.

Enums
ENFORCEMENT_STATE_UNSPECIFIED Der Status der Erzwingung wurde nicht festgelegt.
OFF Nicht erzwungen.
AUDIT Die reCAPTCHA-Bewertung wird erstellt, das Ergebnis wird jedoch nicht erzwungen.
ENFORCE Die reCAPTCHA-Bewertung wird erstellt und das Ergebnis wird erzwungen.