Class: Google::Apis::FirebaseappcheckV1::FirebaseappcheckService

Inherits:

Core::BaseService

• Object
• Core::BaseService
• Google::Apis::FirebaseappcheckV1::FirebaseappcheckService

Defined in:

lib/google/apis/firebaseappcheck_v1/service.rb

Overview

Firebase App Check API

Firebase App Check works alongside other Firebase services to help protect your backend resources from abuse, such as billing fraud or phishing.

Examples:

require 'google/apis/firebaseappcheck_v1'

Firebaseappcheck = Google::Apis::FirebaseappcheckV1 # Alias the module
service = Firebaseappcheck::FirebaseappcheckService.new

See Also:

• https://firebase.google.com/docs/app-check

Constant Summary

DEFAULT_ENDPOINT_TEMPLATE =

"https://firebaseappcheck.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary

• #key ⇒ String

  API key.

• #quota_user ⇒ String

  Available to use for quota purposes for server-side applications.

Instance Method Summary

• #batch_project_app_app_attest_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetAppAttestConfigsResponse

  Atomically gets the AppAttestConfigs for the specified list of apps.

• #batch_project_app_device_check_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetDeviceCheckConfigsResponse

  Atomically gets the DeviceCheckConfigs for the specified list of apps.

• #batch_project_app_play_integrity_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetPlayIntegrityConfigsResponse

  Atomically gets the PlayIntegrityConfigs for the specified list of apps.

• #batch_project_app_recaptcha_enterprise_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaEnterpriseConfigsResponse

  Atomically gets the RecaptchaEnterpriseConfigs for the specified list of apps.

• #batch_project_app_recaptcha_v3_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaV3ConfigsResponse

  Atomically gets the RecaptchaV3Configs for the specified list of apps.

• #batch_project_service_resource_policy_update(parent, google_firebase_appcheck_v1_batch_update_resource_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse

  Atomically updates the specified ResourcePolicy configurations.

• #batch_project_service_update(parent, google_firebase_appcheck_v1_batch_update_services_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesResponse

  Atomically updates the specified Service configurations.

• #create_project_app_debug_token(parent, google_firebase_appcheck_v1_debug_token_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken

  Creates a new DebugToken for the specified app.

• #create_project_service_resource_policy(parent, google_firebase_appcheck_v1_resource_policy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy

  Creates the specified ResourcePolicy configuration.

• #delete_project_app_debug_token(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty

  Deletes the specified DebugToken.

• #delete_project_service_resource_policy(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty

  Deletes the specified ResourcePolicy configuration.

• #exchange_oauth_client_app_attest_assertion(app, google_firebase_appcheck_v1_exchange_app_attest_assertion_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

  Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple.

• #exchange_oauth_client_app_attest_attestation(app, google_firebase_appcheck_v1_exchange_app_attest_attestation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse

  Accepts an App Attest CBOR attestation and verifies it with Apple using your preconfigured team and bundle IDs.

• #exchange_oauth_client_debug_token(app, google_firebase_appcheck_v1_exchange_debug_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

  Validates a debug token secret that you have previously created using CreateDebugToken.

• #exchange_project_app_app_attest_assertion(app, google_firebase_appcheck_v1_exchange_app_attest_assertion_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

  Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple.

• #exchange_project_app_app_attest_attestation(app, google_firebase_appcheck_v1_exchange_app_attest_attestation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse

  Accepts an App Attest CBOR attestation and verifies it with Apple using your preconfigured team and bundle IDs.

• #exchange_project_app_custom_token(app, google_firebase_appcheck_v1_exchange_custom_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

  Validates a custom token signed using your project's Admin SDK service account credentials.

• #exchange_project_app_debug_token(app, google_firebase_appcheck_v1_exchange_debug_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

  Validates a debug token secret that you have previously created using CreateDebugToken.

• #exchange_project_app_device_check_token(app, google_firebase_appcheck_v1_exchange_device_check_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

  Accepts a device_token issued by DeviceCheck, and attempts to validate it with Apple.

• #exchange_project_app_play_integrity_token(app, google_firebase_appcheck_v1_exchange_play_integrity_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

  Validates an integrity verdict response token from Play Integrity.

• #exchange_project_app_recaptcha_enterprise_token(app, google_firebase_appcheck_v1_exchange_recaptcha_enterprise_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

  Validates a reCAPTCHA Enterprise response token.

• #exchange_project_app_recaptcha_v3_token(app, google_firebase_appcheck_v1_exchange_recaptcha_v3_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

  Validates a reCAPTCHA v3 response token.

• #generate_oauth_client_app_attest_challenge(app, google_firebase_appcheck_v1_generate_app_attest_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse

  Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion.

• #generate_project_app_app_attest_challenge(app, google_firebase_appcheck_v1_generate_app_attest_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse

  Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion.

• #generate_project_app_play_integrity_challenge(app, google_firebase_appcheck_v1_generate_play_integrity_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeResponse

  Generates a challenge that protects the integrity of an immediately following integrity verdict request to the Play Integrity API.

• #get_jwk(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PublicJwkSet

  Returns a public JWK set as specified by RFC 7517 that can be used to verify App Check tokens.

• #get_project_app_app_attest_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig

  Gets the AppAttestConfig for the specified app.

• #get_project_app_debug_token(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken

  Gets the specified DebugToken.

• #get_project_app_device_check_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig

  Gets the DeviceCheckConfig for the specified app.

• #get_project_app_play_integrity_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig

  Gets the PlayIntegrityConfig for the specified app.

• #get_project_app_recaptcha_enterprise_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig

  Gets the RecaptchaEnterpriseConfig for the specified app.

• #get_project_app_recaptcha_v3_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config

  Gets the RecaptchaV3Config for the specified app.

• #get_project_service(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service

  Gets the Service configuration for the specified service name.

• #get_project_service_resource_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy

  Gets the requested ResourcePolicy configuration.

• #initialize ⇒ FirebaseappcheckService constructor

  A new instance of FirebaseappcheckService.

• #list_project_app_debug_tokens(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListDebugTokensResponse

  Lists all DebugTokens for the specified app.

• #list_project_service_resource_policies(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListResourcePoliciesResponse

  Lists all ResourcePolicy configurations for the specified project and service.

• #list_project_services(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListServicesResponse

  Lists all Service configurations for the specified project.

• #mint_project_app_app_check_token(app, google_firebase_appcheck_v1_mint_app_check_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1MintAppCheckTokenResponse

  Mints a new App Check token for the specified Firebase App.

• #patch_project_app_app_attest_config(name, google_firebase_appcheck_v1_app_attest_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig

  Updates the AppAttestConfig for the specified app.

• #patch_project_app_debug_token(name, google_firebase_appcheck_v1_debug_token_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken

  Updates the specified DebugToken.

• #patch_project_app_device_check_config(name, google_firebase_appcheck_v1_device_check_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig

  Updates the DeviceCheckConfig for the specified app.

• #patch_project_app_play_integrity_config(name, google_firebase_appcheck_v1_play_integrity_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig

  Updates the PlayIntegrityConfig for the specified app.

• #patch_project_app_recaptcha_enterprise_config(name, google_firebase_appcheck_v1_recaptcha_enterprise_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig

  Updates the RecaptchaEnterpriseConfig for the specified app.

• #patch_project_app_recaptcha_v3_config(name, google_firebase_appcheck_v1_recaptcha_v3_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config

  Updates the RecaptchaV3Config for the specified app.

• #patch_project_service(name, google_firebase_appcheck_v1_service_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service

  Updates the specified Service configuration.

• #patch_project_service_resource_policy(name, google_firebase_appcheck_v1_resource_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy

  Updates the specified ResourcePolicy configuration.

Constructor Details

#initialize ⇒ FirebaseappcheckService

Returns a new instance of FirebaseappcheckService.

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-firebaseappcheck_v1',
        client_version: Google::Apis::FirebaseappcheckV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

• (String) —

  API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

• (String) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#batch_project_app_app_attest_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetAppAttestConfigsResponse

Atomically gets the AppAttestConfigs for the specified list of apps.

Parameters:

• parent (String) —

  Required. The parent project name shared by all AppAttestConfigs being retrieved, in the format projects/`project_number` The parent collection in the name field of any resource being retrieved must match this field, or the entire batch fails.

• names (Array<String>, String) (defaults to: nil) —

  Required. The relative resource names of the AppAttestConfigs to retrieve, in the format projects/`project_number`/apps/`app_id`/appAttestConfig A maximum of 100 objects can be retrieved in a batch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetAppAttestConfigsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetAppAttestConfigsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 712

def batch_project_app_app_attest_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apps/-/appAttestConfig:batchGet', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetAppAttestConfigsResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetAppAttestConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['names'] = names unless names.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_app_device_check_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetDeviceCheckConfigsResponse

Atomically gets the DeviceCheckConfigs for the specified list of apps. For security reasons, the private_key field is never populated in the response.

Parameters:

• parent (String) —

  Required. The parent project name shared by all DeviceCheckConfigs being retrieved, in the format projects/`project_number` The parent collection in the name field of any resource being retrieved must match this field, or the entire batch fails.

• names (Array<String>, String) (defaults to: nil) —

  Required. The relative resource names of the DeviceCheckConfigs to retrieve, in the format projects/`project_number`/apps/`app_id`/deviceCheckConfig A maximum of 100 objects can be retrieved in a batch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetDeviceCheckConfigsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetDeviceCheckConfigsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1020

def batch_project_app_device_check_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apps/-/deviceCheckConfig:batchGet', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetDeviceCheckConfigsResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetDeviceCheckConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['names'] = names unless names.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_app_play_integrity_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetPlayIntegrityConfigsResponse

Atomically gets the PlayIntegrityConfigs for the specified list of apps.

Parameters:

• parent (String) —

  Required. The parent project name shared by all PlayIntegrityConfigs being retrieved, in the format projects/`project_number` The parent collection in the name field of any resource being retrieved must match this field, or the entire batch fails.

• names (Array<String>, String) (defaults to: nil) —

  Required. The relative resource names of the PlayIntegrityConfigs to retrieve, in the format `projects/`project_number`/apps/`app_id`/playIntegrityConfig ` A maximum of 100 objects can be retrieved in a batch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetPlayIntegrityConfigsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetPlayIntegrityConfigsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1132

def batch_project_app_play_integrity_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apps/-/playIntegrityConfig:batchGet', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetPlayIntegrityConfigsResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetPlayIntegrityConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['names'] = names unless names.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_app_recaptcha_enterprise_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaEnterpriseConfigsResponse

Atomically gets the RecaptchaEnterpriseConfigs for the specified list of apps.

Parameters:

• parent (String) —

  Required. The parent project name shared by all RecaptchaEnterpriseConfigs being retrieved, in the format projects/`project_number` The parent collection in the name field of any resource being retrieved must match this field, or the entire batch fails.

• names (Array<String>, String) (defaults to: nil) —

  Required. The relative resource names of the RecaptchaEnterpriseConfigs to retrieve, in the format: projects/`project_number`/apps/`app_id`/ recaptchaEnterpriseConfig A maximum of 100 objects can be retrieved in a batch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaEnterpriseConfigsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaEnterpriseConfigsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1243

def batch_project_app_recaptcha_enterprise_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apps/-/recaptchaEnterpriseConfig:batchGet', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaEnterpriseConfigsResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaEnterpriseConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['names'] = names unless names.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_app_recaptcha_v3_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaV3ConfigsResponse

Atomically gets the RecaptchaV3Configs for the specified list of apps. For security reasons, the site_secret field is never populated in the response.

Parameters:

• parent (String) —

  Required. The parent project name shared by all RecaptchaV3Configs being retrieved, in the format projects/`project_number` The parent collection in the name field of any resource being retrieved must match this field, or the entire batch fails.

• names (Array<String>, String) (defaults to: nil) —

  Required. The relative resource names of the RecaptchaV3Configs to retrieve, in the format: `projects/`project_number`/apps/`app_id`/recaptchaV3Config ` A maximum of 100 objects can be retrieved in a batch.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaV3ConfigsResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaV3ConfigsResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1355

def batch_project_app_recaptcha_v3_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/apps/-/recaptchaV3Config:batchGet', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaV3ConfigsResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaV3ConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['names'] = names unless names.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_service_resource_policy_update(parent, google_firebase_appcheck_v1_batch_update_resource_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse

Atomically updates the specified ResourcePolicy configurations.

Parameters:

• parent (String) —

  Required. The parent service name, in the format projects/`project_number`/ services/`service_id` The parent collection in the name field of any resource being updated must match this field, or the entire batch fails.

• google_firebase_appcheck_v1_batch_update_resource_policies_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1631

def batch_project_service_resource_policy_update(parent, google_firebase_appcheck_v1_batch_update_resource_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/resourcePolicies:batchUpdate', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest::Representation
  command.request_object = google_firebase_appcheck_v1_batch_update_resource_policies_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_service_update(parent, google_firebase_appcheck_v1_batch_update_services_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesResponse

Atomically updates the specified Service configurations.

Parameters:

• parent (String) —

  Required. The parent project name shared by all Service configurations being updated, in the format projects/`project_number` The parent collection in the name field of any resource being updated must match this field, or the entire batch fails.

• google_firebase_appcheck_v1_batch_update_services_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1464

def batch_project_service_update(parent, google_firebase_appcheck_v1_batch_update_services_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/services:batchUpdate', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesRequest::Representation
  command.request_object = google_firebase_appcheck_v1_batch_update_services_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_app_debug_token(parent, google_firebase_appcheck_v1_debug_token_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken

Creates a new DebugToken for the specified app. For security reasons, after the creation operation completes, the token field cannot be updated or retrieved, but you can revoke the debug token using DeleteDebugToken. Each app can have a maximum of 20 debug tokens.

Parameters:

• parent (String) —

  Required. The relative resource name of the parent app in which the specified DebugToken will be created, in the format: projects/`project_number`/apps/` app_id`

• google_firebase_appcheck_v1_debug_token_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 820

def create_project_app_debug_token(parent, google_firebase_appcheck_v1_debug_token_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/debugTokens', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken::Representation
  command.request_object = google_firebase_appcheck_v1_debug_token_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_service_resource_policy(parent, google_firebase_appcheck_v1_resource_policy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy

Creates the specified ResourcePolicy configuration.

Parameters:

• parent (String) —

  Required. The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: projects/` project_number`/services/`service_id` Note that the service_id element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs.

• google_firebase_appcheck_v1_resource_policy_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1668

def create_project_service_resource_policy(parent, google_firebase_appcheck_v1_resource_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/resourcePolicies', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy::Representation
  command.request_object = google_firebase_appcheck_v1_resource_policy_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_app_debug_token(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty

Deletes the specified DebugToken. A deleted debug token cannot be used to exchange for an App Check token. Use this method when you suspect the secret token has been compromised or when you no longer need the debug token.

Parameters:

• name (String) —

  Required. The relative resource name of the DebugToken to delete, in the format: projects/`project_number`/apps/`app_id`/debugTokens/` debug_token_id`

• etag (String) (defaults to: nil) —

  Optional. The checksum to be validated against the current DebugToken, to ensure the client has an up-to-date value before proceeding. This checksum is computed by the server based on the values of fields in the DebugToken object, and can be obtained from the DebugToken object received from the last CreateDebugToken, GetDebugToken, ListDebugTokens, or UpdateDebugToken call. This etag is strongly validated as defined by RFC 7232.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 863

def delete_project_app_debug_token(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_service_resource_policy(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty

Deletes the specified ResourcePolicy configuration.

Parameters:

• name (String) —

  Required. The relative resource name of the ResourcePolicy to delete, in the format: projects/`project_number`/services/`service_id`/resourcePolicies/` resource_policy_id`

• etag (String) (defaults to: nil) —

  The checksum to be validated against the current ResourcePolicy, to ensure the client has an up-to-date value before proceeding. This checksum is computed by the server based on the values of fields in the ResourcePolicy object, and can be obtained from the ResourcePolicy object received from the last CreateResourcePolicy, GetResourcePolicy, ListResourcePolicies, UpdateResourcePolicy, or BatchUpdateResourcePolicies call. This etag is strongly validated as defined by RFC 7232.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1710

def delete_project_service_resource_policy(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#exchange_oauth_client_app_attest_assertion(app, google_firebase_appcheck_v1_exchange_app_attest_assertion_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns an AppCheckToken.

Parameters:

• app (String) —

  Required. The relative resource name of the iOS app, in the format: projects/`project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_exchange_app_attest_assertion_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 116

def exchange_oauth_client_app_attest_assertion(app, google_firebase_appcheck_v1_exchange_app_attest_assertion_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:exchangeAppAttestAssertion', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest::Representation
  command.request_object = google_firebase_appcheck_v1_exchange_app_attest_assertion_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#exchange_oauth_client_app_attest_attestation(app, google_firebase_appcheck_v1_exchange_app_attest_attestation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse

Accepts an App Attest CBOR attestation and verifies it with Apple using your preconfigured team and bundle IDs. If valid, returns an attestation artifact that can later be exchanged for an AppCheckToken using ExchangeAppAttestAssertion. For convenience and performance, this method's response object will also contain an AppCheckToken (if the verification is successful).

Parameters:

• app (String) —

  Required. The relative resource name of the iOS app, in the format: projects/`project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_exchange_app_attest_attestation_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 158

def exchange_oauth_client_app_attest_attestation(app, google_firebase_appcheck_v1_exchange_app_attest_attestation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:exchangeAppAttestAttestation', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationRequest::Representation
  command.request_object = google_firebase_appcheck_v1_exchange_app_attest_attestation_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#exchange_oauth_client_debug_token(app, google_firebase_appcheck_v1_exchange_debug_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

Validates a debug token secret that you have previously created using CreateDebugToken. If valid, returns an AppCheckToken. Note that a restrictive quota is enforced on this method to prevent accidental exposure of the app to abuse.

Parameters:

• app (String) —

  Required. The relative resource name of the app, in the format: projects/` project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_exchange_debug_token_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 198

def exchange_oauth_client_debug_token(app, google_firebase_appcheck_v1_exchange_debug_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:exchangeDebugToken', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest::Representation
  command.request_object = google_firebase_appcheck_v1_exchange_debug_token_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#exchange_project_app_app_attest_assertion(app, google_firebase_appcheck_v1_exchange_app_attest_assertion_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns an AppCheckToken.

Parameters:

• app (String) —

  Required. The relative resource name of the iOS app, in the format: projects/`project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_exchange_app_attest_assertion_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 276

def exchange_project_app_app_attest_assertion(app, google_firebase_appcheck_v1_exchange_app_attest_assertion_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:exchangeAppAttestAssertion', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest::Representation
  command.request_object = google_firebase_appcheck_v1_exchange_app_attest_assertion_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#exchange_project_app_app_attest_attestation(app, google_firebase_appcheck_v1_exchange_app_attest_attestation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse

Accepts an App Attest CBOR attestation and verifies it with Apple using your preconfigured team and bundle IDs. If valid, returns an attestation artifact that can later be exchanged for an AppCheckToken using ExchangeAppAttestAssertion. For convenience and performance, this method's response object will also contain an AppCheckToken (if the verification is successful).

Parameters:

• app (String) —

  Required. The relative resource name of the iOS app, in the format: projects/`project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_exchange_app_attest_attestation_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 318

def exchange_project_app_app_attest_attestation(app, google_firebase_appcheck_v1_exchange_app_attest_attestation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:exchangeAppAttestAttestation', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationRequest::Representation
  command.request_object = google_firebase_appcheck_v1_exchange_app_attest_attestation_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#exchange_project_app_custom_token(app, google_firebase_appcheck_v1_exchange_custom_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

Validates a custom token signed using your project's Admin SDK service account credentials. If valid, returns an AppCheckToken.

Parameters:

• app (String) —

  Required. The relative resource name of the app, in the format: projects/` project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_exchange_custom_token_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeCustomTokenRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 356

def exchange_project_app_custom_token(app, google_firebase_appcheck_v1_exchange_custom_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:exchangeCustomToken', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeCustomTokenRequest::Representation
  command.request_object = google_firebase_appcheck_v1_exchange_custom_token_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#exchange_project_app_debug_token(app, google_firebase_appcheck_v1_exchange_debug_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

Validates a debug token secret that you have previously created using CreateDebugToken. If valid, returns an AppCheckToken. Note that a restrictive quota is enforced on this method to prevent accidental exposure of the app to abuse.

Parameters:

• app (String) —

  Required. The relative resource name of the app, in the format: projects/` project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_exchange_debug_token_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 396

def exchange_project_app_debug_token(app, google_firebase_appcheck_v1_exchange_debug_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:exchangeDebugToken', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest::Representation
  command.request_object = google_firebase_appcheck_v1_exchange_debug_token_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#exchange_project_app_device_check_token(app, google_firebase_appcheck_v1_exchange_device_check_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

Accepts a device_token issued by DeviceCheck, and attempts to validate it with Apple. If valid, returns an AppCheckToken.

Parameters:

• app (String) —

  Required. The relative resource name of the iOS app, in the format: projects/`project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_exchange_device_check_token_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeDeviceCheckTokenRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 435

def exchange_project_app_device_check_token(app, google_firebase_appcheck_v1_exchange_device_check_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:exchangeDeviceCheckToken', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeDeviceCheckTokenRequest::Representation
  command.request_object = google_firebase_appcheck_v1_exchange_device_check_token_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#exchange_project_app_play_integrity_token(app, google_firebase_appcheck_v1_exchange_play_integrity_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

Validates an integrity verdict response token from Play Integrity. If valid, returns an AppCheckToken.

Parameters:

• app (String) —

  Required. The relative resource name of the Android app, in the format: projects/`project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_exchange_play_integrity_token_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangePlayIntegrityTokenRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 474

def exchange_project_app_play_integrity_token(app, google_firebase_appcheck_v1_exchange_play_integrity_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:exchangePlayIntegrityToken', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangePlayIntegrityTokenRequest::Representation
  command.request_object = google_firebase_appcheck_v1_exchange_play_integrity_token_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#exchange_project_app_recaptcha_enterprise_token(app, google_firebase_appcheck_v1_exchange_recaptcha_enterprise_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

Validates a reCAPTCHA Enterprise response token. If valid, returns an AppCheckToken.

Parameters:

• app (String) —

  Required. The relative resource name of the web app, in the format: projects/`project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_exchange_recaptcha_enterprise_token_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeRecaptchaEnterpriseTokenRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 513

def exchange_project_app_recaptcha_enterprise_token(app, google_firebase_appcheck_v1_exchange_recaptcha_enterprise_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:exchangeRecaptchaEnterpriseToken', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeRecaptchaEnterpriseTokenRequest::Representation
  command.request_object = google_firebase_appcheck_v1_exchange_recaptcha_enterprise_token_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#exchange_project_app_recaptcha_v3_token(app, google_firebase_appcheck_v1_exchange_recaptcha_v3_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken

Validates a reCAPTCHA v3 response token. If valid, returns an AppCheckToken.

Parameters:

• app (String) —

  Required. The relative resource name of the web app, in the format: projects/`project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_exchange_recaptcha_v3_token_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeRecaptchaV3TokenRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 551

def exchange_project_app_recaptcha_v3_token(app, google_firebase_appcheck_v1_exchange_recaptcha_v3_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:exchangeRecaptchaV3Token', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeRecaptchaV3TokenRequest::Representation
  command.request_object = google_firebase_appcheck_v1_exchange_recaptcha_v3_token_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_oauth_client_app_attest_challenge(app, google_firebase_appcheck_v1_generate_app_attest_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse

Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.

Parameters:

• app (String) —

  Required. The relative resource name of the iOS app, in the format: projects/`project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_generate_app_attest_challenge_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 237

def generate_oauth_client_app_attest_challenge(app, google_firebase_appcheck_v1_generate_app_attest_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:generateAppAttestChallenge', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest::Representation
  command.request_object = google_firebase_appcheck_v1_generate_app_attest_challenge_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_project_app_app_attest_challenge(app, google_firebase_appcheck_v1_generate_app_attest_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse

Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.

Parameters:

• app (String) —

  Required. The relative resource name of the iOS app, in the format: projects/`project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_generate_app_attest_challenge_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 590

def generate_project_app_app_attest_challenge(app, google_firebase_appcheck_v1_generate_app_attest_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:generateAppAttestChallenge', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest::Representation
  command.request_object = google_firebase_appcheck_v1_generate_app_attest_challenge_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_project_app_play_integrity_challenge(app, google_firebase_appcheck_v1_generate_play_integrity_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeResponse

Generates a challenge that protects the integrity of an immediately following integrity verdict request to the Play Integrity API. The next call to ExchangePlayIntegrityToken using the resulting integrity token will verify the presence and validity of the challenge. A challenge should not be reused for multiple calls.

Parameters:

• app (String) —

  Required. The relative resource name of the app, in the format: projects/` project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_generate_play_integrity_challenge_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 631

def generate_project_app_play_integrity_challenge(app, google_firebase_appcheck_v1_generate_play_integrity_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:generatePlayIntegrityChallenge', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeRequest::Representation
  command.request_object = google_firebase_appcheck_v1_generate_play_integrity_challenge_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeResponse
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_jwk(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PublicJwkSet

Returns a public JWK set as specified by RFC 7517 that can be used to verify App Check tokens. Exactly one of the public keys in the returned set will successfully validate any App Check token that is currently valid.

Parameters:

• name (String) —

  Required. The relative resource name to the public JWK set. Must always be exactly the string jwks.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PublicJwkSet) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PublicJwkSet)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 79

def get_jwk(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PublicJwkSet::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PublicJwkSet
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_app_app_attest_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig

Gets the AppAttestConfig for the specified app.

Parameters:

• name (String) —

  Required. The relative resource name of the AppAttestConfig, in the format: projects/`project_number`/apps/`app_id`/appAttestConfig

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 744

def get_project_app_app_attest_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_app_debug_token(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken

Gets the specified DebugToken. For security reasons, the token field is never populated in the response.

Parameters:

• name (String) —

  Required. The relative resource name of the debug token, in the format: projects/`project_number`/apps/`app_id`/debugTokens/`debug_token_id`

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 896

def get_project_app_debug_token(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_app_device_check_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig

Gets the DeviceCheckConfig for the specified app. For security reasons, the private_key field is never populated in the response.

Parameters:

• name (String) —

  Required. The relative resource name of the DeviceCheckConfig, in the format: projects/project_number/apps/app_id/deviceCheckConfig``

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1053

def get_project_app_device_check_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_app_play_integrity_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig

Gets the PlayIntegrityConfig for the specified app.

Parameters:

• name (String) —

  Required. The relative resource name of the PlayIntegrityConfig, in the format: projects/`project_number`/apps/`app_id`/playIntegrityConfig

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1164

def get_project_app_play_integrity_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_app_recaptcha_enterprise_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig

Gets the RecaptchaEnterpriseConfig for the specified app.

Parameters:

• name (String) —

  Required. The relative resource name of the RecaptchaEnterpriseConfig, in the format: `projects/`project_number`/apps/`app_id`/recaptchaEnterpriseConfig `

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1276

def get_project_app_recaptcha_enterprise_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_app_recaptcha_v3_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config

Gets the RecaptchaV3Config for the specified app. For security reasons, the site_secret field is never populated in the response.

Parameters:

• name (String) —

  Required. The relative resource name of the RecaptchaV3Config, in the format: projects/project_number/apps/app_id/recaptchaV3Config``

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1388

def get_project_app_recaptcha_v3_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_service(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service

Gets the Service configuration for the specified service name.

Parameters:

• name (String) —

  Required. The relative resource name of the Service to retrieve, in the format: projects/`project_number`/services/`service_id` Note that the service_id element must be a supported service ID. Consult the Service.name field for a list of supported service IDs.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1499

def get_project_service(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_service_resource_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy

Gets the requested ResourcePolicy configuration.

Parameters:

• name (String) —

  Required. The relative resource name of the ResourcePolicy to retrieve, in the format: projects/`project_number`/services/`service_id`/resourcePolicies/` resource_policy_id` Note that the service_id element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1745

def get_project_service_resource_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_app_debug_tokens(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListDebugTokensResponse

Lists all DebugTokens for the specified app. For security reasons, the token field is never populated in the response.

Parameters:

• parent (String) —

  Required. The relative resource name of the parent app for which to list each associated DebugToken, in the format: projects/`project_number`/apps/` app_id`

• page_size (Fixnum) (defaults to: nil) —

  The maximum number of DebugTokens to return in the response. Note that an app can have at most 20 debug tokens. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

• page_token (String) (defaults to: nil) —

  Token returned from a previous call to ListDebugTokens indicating where in the set of DebugTokens to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDebugTokens must match the call that provided the page token; if they do not match, the result is undefined.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListDebugTokensResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListDebugTokensResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 940

def list_project_app_debug_tokens(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/debugTokens', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListDebugTokensResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListDebugTokensResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_service_resource_policies(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListResourcePoliciesResponse

Lists all ResourcePolicy configurations for the specified project and service.

Parameters:

• parent (String) —

  Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: projects/`project_number`/ services/`service_id` Note that the service_id element must be a supported service ID. Consult the ResourcePolicy.name field for a list of supported service IDs.

• filter (String) (defaults to: nil) —

  Optional. Filters the results by the specified rule. For the exact syntax of this field, please consult the AIP-160 standard. Currently, since the only fields in the ResourcePolicy resource are the scalar fields enforcement_mode and target_resource, this method does not support the traversal operator (.) or the has operator (:). Here are some examples of valid filters: * enforcement_mode = ENFORCED * target_resource = "// oauth2.googleapis.com/projects/12345/oauthClients/" * enforcement_mode = ENFORCED AND target_resource = "//oauth2.googleapis.com/projects/12345/ oauthClients/"

• page_size (Fixnum) (defaults to: nil) —

  The maximum number of ResourcePolicy objects to return in the response. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

• page_token (String) (defaults to: nil) —

  Token returned from a previous call to ListResourcePolicies indicating where in the set of ResourcePolicy objects to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourcePolicies must match the call that provided the page token; if they do not match, the result is undefined.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListResourcePoliciesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListResourcePoliciesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1800

def list_project_service_resource_policies(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/resourcePolicies', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListResourcePoliciesResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListResourcePoliciesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_services(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListServicesResponse

Lists all Service configurations for the specified project. Only Services which were explicitly configured using UpdateService or BatchUpdateServices will be returned.

Parameters:

• parent (String) —

  Required. The relative resource name of the parent project for which to list each associated Service, in the format: projects/`project_number`

• page_size (Fixnum) (defaults to: nil) —

  The maximum number of Services to return in the response. Only explicitly configured services are returned. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

• page_token (String) (defaults to: nil) —

  Token returned from a previous call to ListServices indicating where in the set of Services to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListServices must match the call that provided the page token; if they do not match, the result is undefined.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListServicesResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListServicesResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1543

def list_project_services(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/services', options)
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListServicesResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListServicesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#mint_project_app_app_check_token(app, google_firebase_appcheck_v1_mint_app_check_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1MintAppCheckTokenResponse

Mints a new App Check token for the specified Firebase App. This method is intended to be called from a privileged environment where the caller can be authorized via Cloud IAM; for example, using a service account. To call this method, the caller must have the firebaseappcheck.googleapis.com/tokens.mint permission. Returns a MintAppCheckTokenResponse.

Parameters:

• app (String) —

  Required. The relative resource name of the app, in the format: projects/` project_number`/apps/`app_id` If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

• google_firebase_appcheck_v1_mint_app_check_token_request_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1MintAppCheckTokenRequest) (defaults to: nil)
• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1MintAppCheckTokenResponse) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1MintAppCheckTokenResponse)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 673

def mint_project_app_app_check_token(app, google_firebase_appcheck_v1_mint_app_check_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+app}:mintAppCheckToken', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1MintAppCheckTokenRequest::Representation
  command.request_object = google_firebase_appcheck_v1_mint_app_check_token_request_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1MintAppCheckTokenResponse::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1MintAppCheckTokenResponse
  command.params['app'] = app unless app.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_app_app_attest_config(name, google_firebase_appcheck_v1_app_attest_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig

Updates the AppAttestConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange AppAttest tokens for App Check tokens.

Parameters:

• name (String) —

  Required. The relative resource name of the App Attest configuration object, in the format: projects/`project_number`/apps/`app_id`/appAttestConfig

• google_firebase_appcheck_v1_app_attest_config_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. A comma-separated list of names of fields in the AppAttestConfig to update. Example: token_ttl.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 781

def patch_project_app_app_attest_config(name, google_firebase_appcheck_v1_app_attest_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig::Representation
  command.request_object = google_firebase_appcheck_v1_app_attest_config_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_app_debug_token(name, google_firebase_appcheck_v1_debug_token_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken

Updates the specified DebugToken. For security reasons, the token field cannot be updated, nor will it be populated in the response, but you can revoke the debug token using DeleteDebugToken.

Parameters:

• name (String) —

  Required. The relative resource name of the debug token, in the format: projects/`project_number`/apps/`app_id`/debugTokens/`debug_token_id`

• google_firebase_appcheck_v1_debug_token_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. A comma-separated list of names of fields in the DebugToken to update. Example: display_name.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 979

def patch_project_app_debug_token(name, google_firebase_appcheck_v1_debug_token_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken::Representation
  command.request_object = google_firebase_appcheck_v1_debug_token_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_app_device_check_config(name, google_firebase_appcheck_v1_device_check_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig

Updates the DeviceCheckConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange DeviceCheck tokens for App Check tokens. For security reasons, the private_key field is never populated in the response.

Parameters:

• name (String) —

  Required. The relative resource name of the DeviceCheck configuration object, in the format: `projects/`project_number`/apps/`app_id`/deviceCheckConfig `

• google_firebase_appcheck_v1_device_check_config_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. A comma-separated list of names of fields in the DeviceCheckConfig to update. Example: key_id,private_key.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1092

def patch_project_app_device_check_config(name, google_firebase_appcheck_v1_device_check_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig::Representation
  command.request_object = google_firebase_appcheck_v1_device_check_config_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_app_play_integrity_config(name, google_firebase_appcheck_v1_play_integrity_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig

Updates the PlayIntegrityConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange Play Integrity tokens for App Check tokens.

Parameters:

• name (String) —

  Required. The relative resource name of the Play Integrity configuration object, in the format: projects/`project_number`/apps/`app_id`/ playIntegrityConfig

• google_firebase_appcheck_v1_play_integrity_config_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. A comma-separated list of names of fields in the PlayIntegrityConfig to update. Example: token_ttl.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1202

def patch_project_app_play_integrity_config(name, google_firebase_appcheck_v1_play_integrity_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig::Representation
  command.request_object = google_firebase_appcheck_v1_play_integrity_config_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_app_recaptcha_enterprise_config(name, google_firebase_appcheck_v1_recaptcha_enterprise_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig

Updates the RecaptchaEnterpriseConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA Enterprise tokens for App Check tokens.

Parameters:

• name (String) —

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

• google_firebase_appcheck_v1_recaptcha_enterprise_config_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. A comma-separated list of names of fields in the RecaptchaEnterpriseConfig to update. Example: site_key.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1314

def patch_project_app_recaptcha_enterprise_config(name, google_firebase_appcheck_v1_recaptcha_enterprise_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig::Representation
  command.request_object = google_firebase_appcheck_v1_recaptcha_enterprise_config_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_app_recaptcha_v3_config(name, google_firebase_appcheck_v1_recaptcha_v3_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config

Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA v3 tokens for App Check tokens. For security reasons, the site_secret field is never populated in the response.

Parameters:

• name (String) —

  Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: `projects/`project_number`/apps/`app_id`/recaptchaV3Config `

• google_firebase_appcheck_v1_recaptcha_v3_config_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. A comma-separated list of names of fields in the RecaptchaV3Config to update. Example: site_secret.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1427

def patch_project_app_recaptcha_v3_config(name, google_firebase_appcheck_v1_recaptcha_v3_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config::Representation
  command.request_object = google_firebase_appcheck_v1_recaptcha_v3_config_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_service(name, google_firebase_appcheck_v1_service_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service

Updates the specified Service configuration.

Parameters:

• name (String) —

  Required. The relative resource name of the service configuration object, in the format: projects/`project_number`/services/`service_id` Note that the service_id element must be a supported service ID. Currently, the following service IDs are supported. Firebase and Google Cloud services: * identitytoolkit.googleapis.com (Firebase Authentication) * firebasedataconnect.googleapis.com (Firebase SQL Connect) * firestore. googleapis.com (Cloud Firestore) * firebasedatabase.googleapis.com ( Firebase Realtime Database) * firebasestorage.googleapis.com (Cloud Storage for Firebase) * firebaseml.googleapis.com (Firebase AI Logic) Google Maps Platform services: * maps-backend.googleapis.com (Maps JavaScript API) * places.googleapis.com (Places API (New)) Other supported Google services: * oauth2.googleapis.com (Google Identity for iOS) Note: While all the supported service_ids may appear to be subdomains of googleapis.com, the service_id has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation.

• google_firebase_appcheck_v1_service_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. A comma-separated list of names of fields in the Service to update. Example: enforcement_mode.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1595

def patch_project_service(name, google_firebase_appcheck_v1_service_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service::Representation
  command.request_object = google_firebase_appcheck_v1_service_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_service_resource_policy(name, google_firebase_appcheck_v1_resource_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy

Updates the specified ResourcePolicy configuration.

Parameters:

• name (String) —

  Required. Identifier. The relative name of the resource policy object, in the format: projects/`project_number`/services/`service_id`/resourcePolicies/` resource_policy_id` Note that the service_id element must be a supported service ID. Currently, the following service IDs are supported: * oauth2. googleapis.com (Google Identity for iOS) resource_policy_id is a system- generated UID.

• google_firebase_appcheck_v1_resource_policy_object (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy) (defaults to: nil)
• update_mask (String) (defaults to: nil) —

  Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: enforcement_mode.

• fields (String) (defaults to: nil) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) (defaults to: nil) —

  Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• options (Google::Apis::RequestOptions) (defaults to: nil) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1842

def patch_project_service_resource_policy(name, google_firebase_appcheck_v1_resource_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy::Representation
  command.request_object = google_firebase_appcheck_v1_resource_policy_object
  command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy::Representation
  command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ResourcePolicy
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end