Class: Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig

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

Overview

An app's reCAPTCHA Enterprise configuration object. This configuration is used by ExchangeRecaptchaEnterpriseToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA Enterprise. It also controls certain properties of the returned AppCheckToken, such as its ttl.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig

Returns a new instance of GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig.



965
966
967
 
# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 965

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

Instance Attribute Details

#name ⇒ String

Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: projects/`project_number`/apps/`app_id`/ recaptchaEnterpriseConfig Corresponds to the JSON property name

Returns:

  • (String) 


946
947
948
 
# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 946

def name
  @name
end

#site_key ⇒ String

The score-based site key created in reCAPTCHA Enterprise used to invoke reCAPTCHA and generate the reCAPTCHA tokens for your application. Important: This is not the site_secret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. Corresponds to the JSON property siteKey

Returns:

  • (String) 


956
957
958
 
# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 956

def site_key
  @site_key
end

#token_ttl ⇒ String

Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. Corresponds to the JSON property tokenTtl

Returns:

  • (String) 


963
964
965
 
# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 963

def token_ttl
  @token_ttl
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



970
971
972
973
974
 
# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 970

def update!(**args)
  @name = args[:name] if args.key?(:name)
  @site_key = args[:site_key] if args.key?(:site_key)
  @token_ttl = args[:token_ttl] if args.key?(:token_ttl)
end