RecaptchaConfig interface

The request interface for updating a reCAPTCHA Config. By enabling reCAPTCHA Enterprise Integration you are agreeing to reCAPTCHA Enterprise Term of Service.

Signature:

export interface RecaptchaConfig

Properties

Property Type Description
emailPasswordEnforcementState RecaptchaProviderEnforcementState The enforcement state of the email password provider.
managedRules RecaptchaManagedRule[] The reCAPTCHA managed rules.
phoneEnforcementState RecaptchaProviderEnforcementState The enforcement state of the phone provider.
recaptchaKeys RecaptchaKey[] The reCAPTCHA keys.
smsTollFraudManagedRules RecaptchaTollFraudManagedRule[] The managed rules for toll fraud provider, containing the enforcement status. The toll fraud provider contains all SMS related user flows.
useAccountDefender boolean Whether to use account defender for reCAPTCHA assessment. The default value is false.
useSmsBotScore boolean Whether to use the rCE bot score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
useSmsTollFraudProtection boolean Whether to use the rCE SMS toll fraud protection risk score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.

RecaptchaConfig.emailPasswordEnforcementState

The enforcement state of the email password provider.

Signature:

emailPasswordEnforcementState?: RecaptchaProviderEnforcementState;

RecaptchaConfig.managedRules

The reCAPTCHA managed rules.

Signature:

managedRules?: RecaptchaManagedRule[];

RecaptchaConfig.phoneEnforcementState

The enforcement state of the phone provider.

Signature:

phoneEnforcementState?: RecaptchaProviderEnforcementState;

RecaptchaConfig.recaptchaKeys

The reCAPTCHA keys.

Signature:

recaptchaKeys?: RecaptchaKey[];

RecaptchaConfig.smsTollFraudManagedRules

The managed rules for toll fraud provider, containing the enforcement status. The toll fraud provider contains all SMS related user flows.

Signature:

smsTollFraudManagedRules?: RecaptchaTollFraudManagedRule[];

RecaptchaConfig.useAccountDefender

Whether to use account defender for reCAPTCHA assessment. The default value is false.

Signature:

useAccountDefender?: boolean;

RecaptchaConfig.useSmsBotScore

Whether to use the rCE bot score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.

Signature:

useSmsBotScore?: boolean;

RecaptchaConfig.useSmsTollFraudProtection

Whether to use the rCE SMS toll fraud protection risk score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.

Signature:

useSmsTollFraudProtection?: boolean;