Class: Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2RecaptchaConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/identitytoolkit_v2/classes.rb,
lib/google/apis/identitytoolkit_v2/representations.rb,
lib/google/apis/identitytoolkit_v2/representations.rb

Overview

Configuration for reCAPTCHA

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV2RecaptchaConfig

Returns a new instance of GoogleCloudIdentitytoolkitV2RecaptchaConfig.



2546
2547
2548
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2546

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#recaptcha_enforcement_state ⇒ Array<Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitV2RecaptchaEnforcementState>

The reCAPTCHA enforcement state for the providers that GCIP supports reCAPTCHA protection. Corresponds to the JSON property recaptchaEnforcementState

Returns:



2524
2525
2526
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2524

def recaptcha_enforcement_state
  @recaptcha_enforcement_state
end

#recaptcha_key ⇒ String

The reCAPTCHA Enterprise key resource name, e.g. "projects/project/keys/key ". This will only be returned when the reCAPTCHA enforcement state is AUDIT or ENFORCE on at least one of the reCAPTCHA providers. Corresponds to the JSON property recaptchaKey

Returns:

  • (String) 


2531
2532
2533
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2531

def recaptcha_key
  @recaptcha_key
end

#use_sms_bot_score ⇒ Boolean Also known as: use_sms_bot_score?

Whether to use the rCE bot score for reCAPTCHA phone provider. Corresponds to the JSON property useSmsBotScore

Returns:

  • (Boolean) 


2536
2537
2538
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2536

def use_sms_bot_score
  @use_sms_bot_score
end

#use_sms_toll_fraud_protection ⇒ Boolean Also known as: use_sms_toll_fraud_protection?

Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider. Corresponds to the JSON property useSmsTollFraudProtection

Returns:

  • (Boolean) 


2543
2544
2545
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2543

def use_sms_toll_fraud_protection
  @use_sms_toll_fraud_protection
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2551
2552
2553
2554
2555
2556
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 2551

def update!(**args)
  @recaptcha_enforcement_state = args[:recaptcha_enforcement_state] if args.key?(:recaptcha_enforcement_state)
  @recaptcha_key = args[:recaptcha_key] if args.key?(:recaptcha_key)
  @use_sms_bot_score = args[:use_sms_bot_score] if args.key?(:use_sms_bot_score)
  @use_sms_toll_fraud_protection = args[:use_sms_toll_fraud_protection] if args.key?(:use_sms_toll_fraud_protection)
end