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

Inherits:
Core::BaseService
  • Object
show all
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:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FirebaseappcheckService

Returns a new instance of FirebaseappcheckService.



48
49
50
51
52
53
 
# 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.



41
42
43
 
# 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.



46
47
48
 
# 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:

Returns:

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



670
671
672
673
674
675
676
677
678
679
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 670

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:

Returns:

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



978
979
980
981
982
983
984
985
986
987
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 978

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:

Returns:

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



1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1090

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:

Returns:

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



1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1201

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:

Returns:

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



1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1313

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:

Returns:

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



1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1584

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:

Returns:

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



1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1422

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:

Returns:

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



778
779
780
781
782
783
784
785
786
787
788
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 778

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:

Returns:

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



1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1621

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:

Returns:

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



821
822
823
824
825
826
827
828
829
830
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 821

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:

Returns:

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



1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1663

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:

Returns:

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



116
117
118
119
120
121
122
123
124
125
126
 
# 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:

Returns:

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



158
159
160
161
162
163
164
165
166
167
168
 
# 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:

Returns:

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



198
199
200
201
202
203
204
205
206
207
208
 
# 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:

Returns:

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



276
277
278
279
280
281
282
283
284
285
286
 
# 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:

Returns:

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



318
319
320
321
322
323
324
325
326
327
328
 
# 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:

Returns:

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



356
357
358
359
360
361
362
363
364
365
366
 
# 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:

Returns:

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



396
397
398
399
400
401
402
403
404
405
406
 
# 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:

Returns:

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



435
436
437
438
439
440
441
442
443
444
445
 
# 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:

Returns:

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



474
475
476
477
478
479
480
481
482
483
484
 
# 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:

Returns:

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



513
514
515
516
517
518
519
520
521
522
523
 
# 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:

Returns:

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



551
552
553
554
555
556
557
558
559
560
561
 
# 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:

Returns:

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



237
238
239
240
241
242
243
244
245
246
247
 
# 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:

Returns:

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



590
591
592
593
594
595
596
597
598
599
600
 
# 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:

Returns:

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



631
632
633
634
635
636
637
638
639
640
641
 
# 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:

Returns:

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



79
80
81
82
83
84
85
86
87
 
# 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:

Returns:

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



702
703
704
705
706
707
708
709
710
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 702

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:

Returns:

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



854
855
856
857
858
859
860
861
862
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 854

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:

Returns:

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



1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1011

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:

Returns:

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



1122
1123
1124
1125
1126
1127
1128
1129
1130
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1122

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:

Returns:

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



1234
1235
1236
1237
1238
1239
1240
1241
1242
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1234

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:

Returns:

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



1346
1347
1348
1349
1350
1351
1352
1353
1354
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1346

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:

Returns:

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



1457
1458
1459
1460
1461
1462
1463
1464
1465
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1457

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:

Returns:

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



1698
1699
1700
1701
1702
1703
1704
1705
1706
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1698

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:

Returns:

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



898
899
900
901
902
903
904
905
906
907
908
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 898

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:

Returns:

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



1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1753

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:

Returns:

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



1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1501

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

#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:

Returns:

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



739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 739

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:

Returns:

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



937
938
939
940
941
942
943
944
945
946
947
948
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 937

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:

Returns:

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



1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1050

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:

Returns:

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



1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1160

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:

Returns:

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



1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1272

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:

Returns:

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



1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1385

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)

  • 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:

Returns:

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



1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1548

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:

Returns:

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



1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
 
# File 'lib/google/apis/firebaseappcheck_v1/service.rb', line 1795

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