Class: Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config
- Inherits:
-
Object
- Object
- Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config
- 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 v3 configuration object. This configuration is used by
ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by
reCAPTCHA v3. It also controls certain properties of the returned
AppCheckToken
, such as its ttl.
Instance Attribute Summary collapse
-
#name ⇒ String
Required.
-
#site_secret ⇒ String
Required.
-
#site_secret_set ⇒ Boolean
(also: #site_secret_set?)
Output only.
-
#token_ttl ⇒ String
Specifies the duration for which App Check tokens exchanged from reCAPTCHA tokens will be valid.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleFirebaseAppcheckV1RecaptchaV3Config
constructor
A new instance of GoogleFirebaseAppcheckV1RecaptchaV3Config.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleFirebaseAppcheckV1RecaptchaV3Config
Returns a new instance of GoogleFirebaseAppcheckV1RecaptchaV3Config.
1013 1014 1015 |
# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 1013 def initialize(**args) update!(**args) end |
Instance Attribute Details
#name ⇒ String
Required. The relative resource name of the reCAPTCHA v3 configuration object,
in the format: `projects/`project_number`/apps/`app_id`/recaptchaV3Config
Corresponds to the JSON property
name`
989 990 991 |
# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 989 def name @name end |
#site_secret ⇒ String
Required. Input only. The site secret used to identify your service for
reCAPTCHA v3 verification. For security reasons, this field will never be
populated in any response.
Corresponds to the JSON property siteSecret
996 997 998 |
# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 996 def site_secret @site_secret end |
#site_secret_set ⇒ Boolean Also known as: site_secret_set?
Output only. Whether the site_secret
field was previously set. Since we will
never return the site_secret
field, this field is the only way to find out
whether it was previously set.
Corresponds to the JSON property siteSecretSet
1003 1004 1005 |
# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 1003 def site_secret_set @site_secret_set end |
#token_ttl ⇒ String
Specifies the duration for which App Check tokens exchanged from reCAPTCHA
tokens will be valid. If unset, a default value of 1 day is assumed. Must be
between 30 minutes and 7 days, inclusive.
Corresponds to the JSON property tokenTtl
1011 1012 1013 |
# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 1011 def token_ttl @token_ttl end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1018 1019 1020 1021 1022 1023 |
# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 1018 def update!(**args) @name = args[:name] if args.key?(:name) @site_secret = args[:site_secret] if args.key?(:site_secret) @site_secret_set = args[:site_secret_set] if args.key?(:site_secret_set) @token_ttl = args[:token_ttl] if args.key?(:token_ttl) end |