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

Inherits:

Object

• Object
• Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig

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

• #name ⇒ String

  Required.

• #site_key ⇒ String

  The score-based site key created in reCAPTCHA Enterprise used to invoke reCAPTCHA and generate the reCAPTCHA tokens for your application.

• #token_ttl ⇒ String

  Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise tokens will be valid.

Instance Method Summary

• #initialize(**args) ⇒ GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig constructor

  A new instance of GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig

Returns a new instance of GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig.

# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 1042

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)

# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 1023

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)

# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 1033

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)

# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 1040

def token_ttl
  @token_ttl
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/firebaseappcheck_v1/classes.rb', line 1047

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