Class: Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig

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

The reCAPTCHA Enterprise integration config.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig

Returns a new instance of GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig.



1457
1458
1459
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1457

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

Instance Attribute Details

#email_password_enforcement_state ⇒ String

The reCAPTCHA config for email/password provider, containing the enforcement status. The email/password provider contains all email related user flows protected by reCAPTCHA. Corresponds to the JSON property emailPasswordEnforcementState

Returns:

  • (String) 


1408
1409
1410
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1408

def email_password_enforcement_state
  @email_password_enforcement_state
end

#managed_rules ⇒ Array<Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2RecaptchaManagedRule>

The managed rules for authentication action based on reCAPTCHA scores. The rules are shared across providers for a given tenant project. Corresponds to the JSON property managedRules

Returns:



1414
1415
1416
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1414

def managed_rules
  @managed_rules
end

#phone_enforcement_state ⇒ String

The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all SMS related user flows protected by reCAPTCHA. Corresponds to the JSON property phoneEnforcementState

Returns:

  • (String) 


1420
1421
1422
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1420

def phone_enforcement_state
  @phone_enforcement_state
end

#recaptcha_keys ⇒ Array<Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2RecaptchaKey>

The reCAPTCHA keys. Corresponds to the JSON property recaptchaKeys

Returns:



1425
1426
1427
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1425

def recaptcha_keys
  @recaptcha_keys
end

#toll_fraud_managed_rules ⇒ Array<Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2RecaptchaTollFraudManagedRule>

The managed rules for the authentication action based on reCAPTCHA toll fraud risk scores. Toll fraud managed rules will only take effect when the phone_enforcement_state is AUDIT or ENFORCE and use_sms_toll_fraud_protection is true. Corresponds to the JSON property tollFraudManagedRules

Returns:



1433
1434
1435
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1433

def toll_fraud_managed_rules
  @toll_fraud_managed_rules
end

#use_account_defender ⇒ Boolean Also known as: use_account_defender?

Whether to use the account defender for reCAPTCHA assessment. Defaults to false. Corresponds to the JSON property useAccountDefender

Returns:

  • (Boolean) 


1439
1440
1441
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1439

def 
  @use_account_defender
end

#use_sms_bot_score ⇒ Boolean Also known as: use_sms_bot_score?

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

Returns:

  • (Boolean) 


1446
1447
1448
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1446

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. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE. Corresponds to the JSON property useSmsTollFraudProtection

Returns:

  • (Boolean) 


1454
1455
1456
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1454

def use_sms_toll_fraud_protection
  @use_sms_toll_fraud_protection
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1462

def update!(**args)
  @email_password_enforcement_state = args[:email_password_enforcement_state] if args.key?(:email_password_enforcement_state)
  @managed_rules = args[:managed_rules] if args.key?(:managed_rules)
  @phone_enforcement_state = args[:phone_enforcement_state] if args.key?(:phone_enforcement_state)
  @recaptcha_keys = args[:recaptcha_keys] if args.key?(:recaptcha_keys)
  @toll_fraud_managed_rules = args[:toll_fraud_managed_rules] if args.key?(:toll_fraud_managed_rules)
  @use_account_defender = args[:use_account_defender] if args.key?(:use_account_defender)
  @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