google-apis-firebaseappcheck_v1beta 0.7.0 → 0.11.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6b277cc22a7a5e38f10ae593366a656a5dbd0acfafca5be1542777283c9705d8
4
- data.tar.gz: b1f286b30a62ec1e5743095d4475914d1ae7c86264c2e9fe7567fcfeb5ae3cb6
3
+ metadata.gz: 1979253eba1c54429fcb21cead287c569b1809335d35369c6c915132ae9e4929
4
+ data.tar.gz: c44f89320409d4d4ed5e7f54c1dab3d3c1989398f252061eb3221e5782b071a8
5
5
  SHA512:
6
- metadata.gz: d159bbd586f8425b7987f2a8bb2e7fb66ef5756d94bdf35be3f05210487d42fc1f9e7225342298c4596fdab31c182e834a33759c7f5f3b209d68878ec1279a49
7
- data.tar.gz: 5f4cdd0cca7414d40a9f114f6db2664ed09f6e1247846a509576ca09d6a1eaa7feb20e8d4fc917e2e15952a1a584c2cf6aefefb4bcfbb1f48d06ea5fc874c368
6
+ metadata.gz: e65042dfe62b9df264ad19ada5371a0a076091d386333e808dd501b539980782c40298928b4cd891c5d44a7c34d928a3661d66523cb8a74454243962d5be6b9d
7
+ data.tar.gz: 6a891550f2b7e560034a25eb00fa5788230ed68cbdceda8931204259b4d651d2f18b50ea7b84d6c374a3a12c31a6ceadeb1bf4e3b5952c6ab3f8a679ef2dd9d4
data/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # Release history for google-apis-firebaseappcheck_v1beta
2
2
 
3
+ ### v0.11.0 (2022-01-19)
4
+
5
+ * Regenerated from discovery document revision 20220116
6
+ * Regenerated using generator version 0.4.1
7
+
8
+ ### v0.10.0 (2021-12-14)
9
+
10
+ * Unspecified changes
11
+
12
+ ### v0.9.0 (2021-11-01)
13
+
14
+ * Regenerated from discovery document revision 20211029
15
+
16
+ ### v0.8.0 (2021-10-20)
17
+
18
+ * Regenerated from discovery document revision 20211015
19
+
3
20
  ### v0.7.0 (2021-09-29)
4
21
 
5
22
  * Regenerated from discovery document revision 20210924
data/OVERVIEW.md CHANGED
@@ -51,7 +51,7 @@ require "google/apis/firebaseappcheck_v1beta"
51
51
  client = Google::Apis::FirebaseappcheckV1beta::FirebaseappcheckService.new
52
52
 
53
53
  # Authenticate calls
54
- client.authentication = # ... use the googleauth gem to create credentials
54
+ client.authorization = # ... use the googleauth gem to create credentials
55
55
  ```
56
56
 
57
57
  See the class reference docs for information on the methods you can call from a client.
@@ -60,8 +60,8 @@ See the class reference docs for information on the methods you can call from a
60
60
 
61
61
  More detailed descriptions of the Google simple REST clients are available in two documents.
62
62
 
63
- * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
- * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
65
 
66
66
  (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Firebaseappcheck service in particular.)
67
67
 
@@ -22,21 +22,19 @@ module Google
22
22
  module Apis
23
23
  module FirebaseappcheckV1beta
24
24
 
25
- # Response object for GenerateAppAttestChallenge
25
+ # Response message for the GenerateAppAttestChallenge method.
26
26
  class GoogleFirebaseAppcheckV1betaAppAttestChallengeResponse
27
27
  include Google::Apis::Core::Hashable
28
28
 
29
- # A one time use challenge for the client to pass to Apple's App Attest API.
29
+ # A one-time use challenge for the client to pass to the App Attest API.
30
30
  # Corresponds to the JSON property `challenge`
31
31
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
32
32
  # @return [String]
33
33
  attr_accessor :challenge
34
34
 
35
- # The duration from the time this challenge is minted until it is expired. This
36
- # field is intended to ease client-side token management, since the device may
37
- # have clock skew, but is still able to accurately measure a duration. This
38
- # expiration is intended to minimize the replay window within which a single
39
- # challenge may be reused. See AIP 142 for naming of this field.
35
+ # The duration from the time this challenge is minted until its expiration. This
36
+ # field is intended to ease client-side token management, since the client may
37
+ # have clock skew, but is still able to accurately measure a duration.
40
38
  # Corresponds to the JSON property `ttl`
41
39
  # @return [String]
42
40
  attr_accessor :ttl
@@ -54,11 +52,11 @@ module Google
54
52
 
55
53
  # An app's App Attest configuration object. This configuration controls certain
56
54
  # properties of the App Check token returned by ExchangeAppAttestAttestation and
57
- # ExchangeAppAttestAttestation, such as its ttl. Note that the Team ID
58
- # registered with your app is used as part of the validation process. Please
59
- # register it via the Firebase Console or programmatically via the [Firebase
60
- # Management Service](https://firebase.google.com/docs/projects/api/reference/
61
- # rest/v1beta1/projects.iosApps/patch).
55
+ # ExchangeAppAttestAssertion, such as its ttl. Note that the Team ID registered
56
+ # with your app is used as part of the validation process. Please register it
57
+ # via the Firebase Console or programmatically via the [Firebase Management
58
+ # Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/
59
+ # projects.iosApps/patch).
62
60
  class GoogleFirebaseAppcheckV1betaAppAttestConfig
63
61
  include Google::Apis::Core::Hashable
64
62
 
@@ -173,6 +171,25 @@ module Google
173
171
  end
174
172
  end
175
173
 
174
+ # Response message for the BatchGetRecaptchaEnterpriseConfigs method.
175
+ class GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse
176
+ include Google::Apis::Core::Hashable
177
+
178
+ # RecaptchaEnterpriseConfigs retrieved.
179
+ # Corresponds to the JSON property `configs`
180
+ # @return [Array<Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig>]
181
+ attr_accessor :configs
182
+
183
+ def initialize(**args)
184
+ update!(**args)
185
+ end
186
+
187
+ # Update properties of this object
188
+ def update!(**args)
189
+ @configs = args[:configs] if args.key?(:configs)
190
+ end
191
+ end
192
+
176
193
  # Response message for the BatchGetSafetyNetConfigs method.
177
194
  class GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse
178
195
  include Google::Apis::Core::Hashable
@@ -252,17 +269,17 @@ module Google
252
269
  # @return [String]
253
270
  attr_accessor :display_name
254
271
 
255
- # The relative resource name of the debug token, in the format: ``` projects/`
256
- # project_number`/apps/`app_id`/debugTokens/`debug_token_id` ```
272
+ # Required. The relative resource name of the debug token, in the format: ```
273
+ # projects/`project_number`/apps/`app_id`/debugTokens/`debug_token_id` ```
257
274
  # Corresponds to the JSON property `name`
258
275
  # @return [String]
259
276
  attr_accessor :name
260
277
 
261
- # Input only. Immutable. The secret token itself. Must be provided during
262
- # creation, and must be a UUID4, case insensitive. This field is immutable once
263
- # set, and cannot be provided during an UpdateDebugToken request. You can,
264
- # however, delete this debug token using DeleteDebugToken to revoke it. For
265
- # security reasons, this field will never be populated in any response.
278
+ # Required. Input only. Immutable. The secret token itself. Must be provided
279
+ # during creation, and must be a UUID4, case insensitive. This field is
280
+ # immutable once set, and cannot be provided during an UpdateDebugToken request.
281
+ # You can, however, delete this debug token using DeleteDebugToken to revoke it.
282
+ # For security reasons, this field will never be populated in any response.
266
283
  # Corresponds to the JSON property `token`
267
284
  # @return [String]
268
285
  attr_accessor :token
@@ -338,23 +355,26 @@ module Google
338
355
  end
339
356
  end
340
357
 
341
- # Request message for ExchangeAppAttestAssertion
358
+ # Request message for the ExchangeAppAttestAssertion method.
342
359
  class GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest
343
360
  include Google::Apis::Core::Hashable
344
361
 
345
- # The artifact previously returned by ExchangeAppAttestAttestation.
362
+ # Required. The artifact returned by a previous call to
363
+ # ExchangeAppAttestAttestation.
346
364
  # Corresponds to the JSON property `artifact`
347
365
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
348
366
  # @return [String]
349
367
  attr_accessor :artifact
350
368
 
351
- # The CBOR encoded assertion provided by the Apple App Attest SDK.
369
+ # Required. The CBOR-encoded assertion returned by the client-side App Attest
370
+ # API.
352
371
  # Corresponds to the JSON property `assertion`
353
372
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
354
373
  # @return [String]
355
374
  attr_accessor :assertion
356
375
 
357
- # A one time challenge returned by GenerateAppAttestChallenge.
376
+ # Required. A one-time challenge returned by an immediately prior call to
377
+ # GenerateAppAttestChallenge.
358
378
  # Corresponds to the JSON property `challenge`
359
379
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
360
380
  # @return [String]
@@ -372,19 +392,19 @@ module Google
372
392
  end
373
393
  end
374
394
 
375
- # Request message for ExchangeAppAttestAttestation
395
+ # Request message for the ExchangeAppAttestAttestation method.
376
396
  class GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest
377
397
  include Google::Apis::Core::Hashable
378
398
 
379
- # Required. The App Attest statement as returned by Apple's client-side App
380
- # Attest API. This is the CBOR object returned by Apple, which will be Base64
381
- # encoded in the JSON API.
399
+ # Required. The App Attest statement returned by the client-side App Attest API.
400
+ # This is a base64url encoded CBOR object in the JSON response.
382
401
  # Corresponds to the JSON property `attestationStatement`
383
402
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
384
403
  # @return [String]
385
404
  attr_accessor :attestation_statement
386
405
 
387
- # Required. The challenge previously generated by the FAC backend.
406
+ # Required. A one-time challenge returned by an immediately prior call to
407
+ # GenerateAppAttestChallenge.
388
408
  # Corresponds to the JSON property `challenge`
389
409
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
390
410
  # @return [String]
@@ -408,12 +428,11 @@ module Google
408
428
  end
409
429
  end
410
430
 
411
- # Response message for ExchangeAppAttestAttestation and
412
- # ExchangeAppAttestDebugAttestation
431
+ # Response message for the ExchangeAppAttestAttestation method.
413
432
  class GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse
414
433
  include Google::Apis::Core::Hashable
415
434
 
416
- # An artifact that should be passed back during the Assertion flow.
435
+ # An artifact that can be used in future calls to ExchangeAppAttestAssertion.
417
436
  # Corresponds to the JSON property `artifact`
418
437
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
419
438
  # @return [String]
@@ -482,7 +501,7 @@ module Google
482
501
 
483
502
  # Required. The `device_token` as returned by Apple's client-side [DeviceCheck
484
503
  # API](https://developer.apple.com/documentation/devicecheck/dcdevice). This is
485
- # the Base64 encoded `Data` (Swift) or `NSData` (ObjC) object.
504
+ # the base64 encoded `Data` (Swift) or `NSData` (ObjC) object.
486
505
  # Corresponds to the JSON property `deviceToken`
487
506
  # @return [String]
488
507
  attr_accessor :device_token
@@ -497,6 +516,27 @@ module Google
497
516
  end
498
517
  end
499
518
 
519
+ # Request message for the ExchangeRecaptchaEnterpriseToken method.
520
+ class GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest
521
+ include Google::Apis::Core::Hashable
522
+
523
+ # Required. The reCAPTCHA token as returned by the [reCAPTCHA Enterprise
524
+ # JavaScript API](https://cloud.google.com/recaptcha-enterprise/docs/instrument-
525
+ # web-pages).
526
+ # Corresponds to the JSON property `recaptchaEnterpriseToken`
527
+ # @return [String]
528
+ attr_accessor :recaptcha_enterprise_token
529
+
530
+ def initialize(**args)
531
+ update!(**args)
532
+ end
533
+
534
+ # Update properties of this object
535
+ def update!(**args)
536
+ @recaptcha_enterprise_token = args[:recaptcha_enterprise_token] if args.key?(:recaptcha_enterprise_token)
537
+ end
538
+ end
539
+
500
540
  # Request message for the ExchangeRecaptchaToken method.
501
541
  class GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest
502
542
  include Google::Apis::Core::Hashable
@@ -537,7 +577,7 @@ module Google
537
577
  end
538
578
  end
539
579
 
540
- # Request message for GenerateAppAttestChallenge
580
+ # Request message for the GenerateAppAttestChallenge method.
541
581
  class GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest
542
582
  include Google::Apis::Core::Hashable
543
583
 
@@ -664,7 +704,7 @@ module Google
664
704
  # The currently active set of public keys that can be used to verify App Check
665
705
  # tokens. This object is a JWK set as specified by [section 5 of RFC 7517](https:
666
706
  # //tools.ietf.org/html/rfc7517#section-5). For security, the response **must
667
- # not** be cached for longer than one day.
707
+ # not** be cached for longer than six hours.
668
708
  class GoogleFirebaseAppcheckV1betaPublicJwkSet
669
709
  include Google::Apis::Core::Hashable
670
710
 
@@ -732,6 +772,49 @@ module Google
732
772
  end
733
773
  end
734
774
 
775
+ # An app's reCAPTCHA Enterprise configuration object. This configuration is used
776
+ # by ExchangeRecaptchaEnterpriseToken to validate reCAPTCHA tokens issued to
777
+ # apps by reCAPTCHA Enterprise. It also controls certain properties of the
778
+ # returned App Check token, such as its ttl.
779
+ class GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig
780
+ include Google::Apis::Core::Hashable
781
+
782
+ # Required. The relative resource name of the reCAPTCHA Enterprise configuration
783
+ # object, in the format: ``` projects/`project_number`/apps/`app_id`/
784
+ # recaptchaEnterpriseConfig ```
785
+ # Corresponds to the JSON property `name`
786
+ # @return [String]
787
+ attr_accessor :name
788
+
789
+ # The score-based site key [created in reCAPTCHA Enterprise](https://cloud.
790
+ # google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [
791
+ # invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/
792
+ # recaptcha-enterprise/docs/instrument-web-pages) for your application.
793
+ # Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but
794
+ # rather your score-based reCAPTCHA Enterprise site key.
795
+ # Corresponds to the JSON property `siteKey`
796
+ # @return [String]
797
+ attr_accessor :site_key
798
+
799
+ # Specifies the duration for which App Check tokens exchanged from reCAPTCHA
800
+ # Enterprise tokens will be valid. If unset, a default value of 1 hour is
801
+ # assumed. Must be between 30 minutes and 7 days, inclusive.
802
+ # Corresponds to the JSON property `tokenTtl`
803
+ # @return [String]
804
+ attr_accessor :token_ttl
805
+
806
+ def initialize(**args)
807
+ update!(**args)
808
+ end
809
+
810
+ # Update properties of this object
811
+ def update!(**args)
812
+ @name = args[:name] if args.key?(:name)
813
+ @site_key = args[:site_key] if args.key?(:site_key)
814
+ @token_ttl = args[:token_ttl] if args.key?(:token_ttl)
815
+ end
816
+ end
817
+
735
818
  # An app's SafetyNet configuration object. This configuration controls certain
736
819
  # properties of the App Check token returned by ExchangeSafetyNetToken, such as
737
820
  # its ttl. Note that your registered SHA-256 certificate fingerprints are used
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module FirebaseappcheckV1beta
18
18
  # Version of the google-apis-firebaseappcheck_v1beta gem
19
- GEM_VERSION = "0.7.0"
19
+ GEM_VERSION = "0.11.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.4.0"
22
+ GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210924"
25
+ REVISION = "20220116"
26
26
  end
27
27
  end
28
28
  end
@@ -58,6 +58,12 @@ module Google
58
58
  include Google::Apis::Core::JsonObjectSupport
59
59
  end
60
60
 
61
+ class GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
61
67
  class GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse
62
68
  class Representation < Google::Apis::Core::JsonRepresentation; end
63
69
 
@@ -124,6 +130,12 @@ module Google
124
130
  include Google::Apis::Core::JsonObjectSupport
125
131
  end
126
132
 
133
+ class GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
127
139
  class GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest
128
140
  class Representation < Google::Apis::Core::JsonRepresentation; end
129
141
 
@@ -172,6 +184,12 @@ module Google
172
184
  include Google::Apis::Core::JsonObjectSupport
173
185
  end
174
186
 
187
+ class GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig
188
+ class Representation < Google::Apis::Core::JsonRepresentation; end
189
+
190
+ include Google::Apis::Core::JsonObjectSupport
191
+ end
192
+
175
193
  class GoogleFirebaseAppcheckV1betaSafetyNetConfig
176
194
  class Representation < Google::Apis::Core::JsonRepresentation; end
177
195
 
@@ -244,6 +262,14 @@ module Google
244
262
  end
245
263
  end
246
264
 
265
+ class GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse
266
+ # @private
267
+ class Representation < Google::Apis::Core::JsonRepresentation
268
+ collection :configs, as: 'configs', class: Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig, decorator: Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig::Representation
269
+
270
+ end
271
+ end
272
+
247
273
  class GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse
248
274
  # @private
249
275
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -337,6 +363,13 @@ module Google
337
363
  end
338
364
  end
339
365
 
366
+ class GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest
367
+ # @private
368
+ class Representation < Google::Apis::Core::JsonRepresentation
369
+ property :recaptcha_enterprise_token, as: 'recaptchaEnterpriseToken'
370
+ end
371
+ end
372
+
340
373
  class GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest
341
374
  # @private
342
375
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -405,6 +438,15 @@ module Google
405
438
  end
406
439
  end
407
440
 
441
+ class GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig
442
+ # @private
443
+ class Representation < Google::Apis::Core::JsonRepresentation
444
+ property :name, as: 'name'
445
+ property :site_key, as: 'siteKey'
446
+ property :token_ttl, as: 'tokenTtl'
447
+ end
448
+ end
449
+
408
450
  class GoogleFirebaseAppcheckV1betaSafetyNetConfig
409
451
  # @private
410
452
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -22,18 +22,8 @@ module Google
22
22
  module FirebaseappcheckV1beta
23
23
  # Firebase App Check API
24
24
  #
25
- # App Check works alongside other Firebase services to help protect your backend
26
- # resources from abuse, such as billing fraud or phishing. With App Check,
27
- # devices running your app will use an app or device attestation provider that
28
- # attests to one or both of the following: * Requests originate from your
29
- # authentic app * Requests originate from an authentic, untampered device This
30
- # attestation is attached to every request your app makes to your Firebase
31
- # backend resources. The Firebase App Check REST API allows you to manage your
32
- # App Check configurations programmatically. It also allows you to exchange
33
- # attestation material for App Check tokens directly without using a Firebase
34
- # SDK. Finally, it allows you to obtain the public key set necessary to validate
35
- # an App Check token yourself. [Learn more about App Check](https://firebase.
36
- # google.com/docs/app-check).
25
+ # Firebase App Check works alongside other Firebase services to help protect
26
+ # your backend resources from abuse, such as billing fraud or phishing.
37
27
  #
38
28
  # @example
39
29
  # require 'google/apis/firebaseappcheck_v1beta'
@@ -94,13 +84,15 @@ module Google
94
84
  execute_or_queue_command(command, &block)
95
85
  end
96
86
 
97
- # Accepts a AppAttest Artifact and Assertion, and uses the developer's
98
- # preconfigured auth token to verify the token with Apple. Returns an
99
- # AttestationToken with the App ID as specified by the `app` field included as
100
- # attested claims.
87
+ # Accepts an App Attest assertion and an artifact previously obtained from
88
+ # ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns
89
+ # an App Check token encapsulated in an AttestationTokenResponse.
101
90
  # @param [String] app
102
- # Required. The full resource name to the iOS App. Format: "projects/`project_id`
103
- # /apps/`app_id`"
91
+ # Required. The relative resource name of the iOS app, in the format: ```
92
+ # projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
93
+ # element can be replaced with the project ID of the Firebase project. Learn
94
+ # more about using project identifiers in Google's [AIP 2510](https://google.aip.
95
+ # dev/cloud/2510) standard.
104
96
  # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest] google_firebase_appcheck_v1beta_exchange_app_attest_assertion_request_object
105
97
  # @param [String] fields
106
98
  # Selector specifying which fields to include in a partial response.
@@ -131,13 +123,18 @@ module Google
131
123
  execute_or_queue_command(command, &block)
132
124
  end
133
125
 
134
- # Accepts a AppAttest CBOR Attestation, and uses the developer's preconfigured
135
- # team and bundle IDs to verify the token with Apple. Returns an Attestation
136
- # Artifact that can later be exchanged for an AttestationToken in
137
- # ExchangeAppAttestAssertion.
126
+ # Accepts an App Attest CBOR attestation and verifies it with Apple using your
127
+ # preconfigured team and bundle IDs. If valid, returns an attestation artifact
128
+ # that can later be exchanged for an AttestationTokenResponse using
129
+ # ExchangeAppAttestAssertion. For convenience and performance, this method's
130
+ # response object will also contain an App Check token encapsulated in an
131
+ # AttestationTokenResponse (if the verification is successful).
138
132
  # @param [String] app
139
- # Required. The full resource name to the iOS App. Format: "projects/`project_id`
140
- # /apps/`app_id`"
133
+ # Required. The relative resource name of the iOS app, in the format: ```
134
+ # projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
135
+ # element can be replaced with the project ID of the Firebase project. Learn
136
+ # more about using project identifiers in Google's [AIP 2510](https://google.aip.
137
+ # dev/cloud/2510) standard.
141
138
  # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest] google_firebase_appcheck_v1beta_exchange_app_attest_attestation_request_object
142
139
  # @param [String] fields
143
140
  # Selector specifying which fields to include in a partial response.
@@ -287,6 +284,45 @@ module Google
287
284
  execute_or_queue_command(command, &block)
288
285
  end
289
286
 
287
+ # Validates a [reCAPTCHA Enterprise response token](https://cloud.google.com/
288
+ # recaptcha-enterprise/docs/create-assessment#retrieve_token). If valid, returns
289
+ # an App Check token encapsulated in an AttestationTokenResponse.
290
+ # @param [String] app
291
+ # Required. The relative resource name of the web app, in the format: ```
292
+ # projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
293
+ # element can be replaced with the project ID of the Firebase project. Learn
294
+ # more about using project identifiers in Google's [AIP 2510](https://google.aip.
295
+ # dev/cloud/2510) standard.
296
+ # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest] google_firebase_appcheck_v1beta_exchange_recaptcha_enterprise_token_request_object
297
+ # @param [String] fields
298
+ # Selector specifying which fields to include in a partial response.
299
+ # @param [String] quota_user
300
+ # Available to use for quota purposes for server-side applications. Can be any
301
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
302
+ # @param [Google::Apis::RequestOptions] options
303
+ # Request-specific options
304
+ #
305
+ # @yield [result, err] Result & error if block supplied
306
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse] parsed result object
307
+ # @yieldparam err [StandardError] error object if request failed
308
+ #
309
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse]
310
+ #
311
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
312
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
313
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
314
+ def exchange_project_app_recaptcha_enterprise_token(app, google_firebase_appcheck_v1beta_exchange_recaptcha_enterprise_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
315
+ command = make_simple_command(:post, 'v1beta/{+app}:exchangeRecaptchaEnterpriseToken', options)
316
+ command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest::Representation
317
+ command.request_object = google_firebase_appcheck_v1beta_exchange_recaptcha_enterprise_token_request_object
318
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse::Representation
319
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse
320
+ command.params['app'] = app unless app.nil?
321
+ command.query['fields'] = fields unless fields.nil?
322
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
323
+ execute_or_queue_command(command, &block)
324
+ end
325
+
290
326
  # Validates a [reCAPTCHA v3 response token](https://developers.google.com/
291
327
  # recaptcha/docs/v3). If valid, returns an App Check token encapsulated in an
292
328
  # AttestationTokenResponse.
@@ -365,11 +401,15 @@ module Google
365
401
  execute_or_queue_command(command, &block)
366
402
  end
367
403
 
368
- # Initiates the App Attest flow by generating a challenge which will be used as
369
- # a type of nonce for this attestation.
404
+ # Generates a challenge that protects the integrity of an immediately following
405
+ # call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A
406
+ # challenge should not be reused for multiple calls.
370
407
  # @param [String] app
371
- # Required. The full resource name to the iOS App. Format: "projects/`project_id`
372
- # /apps/`app_id`"
408
+ # Required. The relative resource name of the iOS app, in the format: ```
409
+ # projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
410
+ # element can be replaced with the project ID of the Firebase project. Learn
411
+ # more about using project identifiers in Google's [AIP 2510](https://google.aip.
412
+ # dev/cloud/2510) standard.
373
413
  # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest] google_firebase_appcheck_v1beta_generate_app_attest_challenge_request_object
374
414
  # @param [String] fields
375
415
  # Selector specifying which fields to include in a partial response.
@@ -400,7 +440,7 @@ module Google
400
440
  execute_or_queue_command(command, &block)
401
441
  end
402
442
 
403
- # Gets the AppAttestConfigs for the specified list of apps atomically.
443
+ # Atomically gets the AppAttestConfigs for the specified list of apps.
404
444
  # @param [String] parent
405
445
  # Required. The parent project name shared by all AppAttestConfigs being
406
446
  # retrieved, in the format ``` projects/`project_number` ``` The parent
@@ -663,8 +703,8 @@ module Google
663
703
  # cannot be updated, nor will it be populated in the response, but you can
664
704
  # revoke the debug token using DeleteDebugToken.
665
705
  # @param [String] name
666
- # The relative resource name of the debug token, in the format: ``` projects/`
667
- # project_number`/apps/`app_id`/debugTokens/`debug_token_id` ```
706
+ # Required. The relative resource name of the debug token, in the format: ```
707
+ # projects/`project_number`/apps/`app_id`/debugTokens/`debug_token_id` ```
668
708
  # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaDebugToken] google_firebase_appcheck_v1beta_debug_token_object
669
709
  # @param [String] update_mask
670
710
  # Required. A comma-separated list of names of fields in the DebugToken to
@@ -699,7 +739,7 @@ module Google
699
739
  execute_or_queue_command(command, &block)
700
740
  end
701
741
 
702
- # Gets the DeviceCheckConfigs for the specified list of apps atomically. For
742
+ # Atomically gets the DeviceCheckConfigs for the specified list of apps. For
703
743
  # security reasons, the `private_key` field is never populated in the response.
704
744
  # @param [String] parent
705
745
  # Required. The parent project name shared by all DeviceCheckConfigs being
@@ -812,7 +852,7 @@ module Google
812
852
  execute_or_queue_command(command, &block)
813
853
  end
814
854
 
815
- # Gets the RecaptchaConfigs for the specified list of apps atomically. For
855
+ # Atomically gets the RecaptchaConfigs for the specified list of apps. For
816
856
  # security reasons, the `site_secret` field is never populated in the response.
817
857
  # @param [String] parent
818
858
  # Required. The parent project name shared by all RecaptchaConfigs being
@@ -924,7 +964,119 @@ module Google
924
964
  execute_or_queue_command(command, &block)
925
965
  end
926
966
 
927
- # Gets the SafetyNetConfigs for the specified list of apps atomically.
967
+ # Atomically gets the RecaptchaEnterpriseConfigs for the specified list of apps.
968
+ # @param [String] parent
969
+ # Required. The parent project name shared by all RecaptchaEnterpriseConfigs
970
+ # being retrieved, in the format ``` projects/`project_number` ``` The parent
971
+ # collection in the `name` field of any resource being retrieved must match this
972
+ # field, or the entire batch fails.
973
+ # @param [Array<String>, String] names
974
+ # Required. The relative resource names of the RecaptchaEnterpriseConfigs to
975
+ # retrieve, in the format: ``` projects/`project_number`/apps/`app_id`/
976
+ # recaptchaEnterpriseConfig ``` A maximum of 100 objects can be retrieved in a
977
+ # batch.
978
+ # @param [String] fields
979
+ # Selector specifying which fields to include in a partial response.
980
+ # @param [String] quota_user
981
+ # Available to use for quota purposes for server-side applications. Can be any
982
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
983
+ # @param [Google::Apis::RequestOptions] options
984
+ # Request-specific options
985
+ #
986
+ # @yield [result, err] Result & error if block supplied
987
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse] parsed result object
988
+ # @yieldparam err [StandardError] error object if request failed
989
+ #
990
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse]
991
+ #
992
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
993
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
994
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
995
+ def batch_project_app_recaptcha_enterprise_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
996
+ command = make_simple_command(:get, 'v1beta/{+parent}/apps/-/recaptchaEnterpriseConfig:batchGet', options)
997
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse::Representation
998
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse
999
+ command.params['parent'] = parent unless parent.nil?
1000
+ command.query['names'] = names unless names.nil?
1001
+ command.query['fields'] = fields unless fields.nil?
1002
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1003
+ execute_or_queue_command(command, &block)
1004
+ end
1005
+
1006
+ # Gets the RecaptchaEnterpriseConfig for the specified app.
1007
+ # @param [String] name
1008
+ # Required. The relative resource name of the RecaptchaEnterpriseConfig, in the
1009
+ # format: ``` projects/`project_number`/apps/`app_id`/recaptchaEnterpriseConfig `
1010
+ # ``
1011
+ # @param [String] fields
1012
+ # Selector specifying which fields to include in a partial response.
1013
+ # @param [String] quota_user
1014
+ # Available to use for quota purposes for server-side applications. Can be any
1015
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1016
+ # @param [Google::Apis::RequestOptions] options
1017
+ # Request-specific options
1018
+ #
1019
+ # @yield [result, err] Result & error if block supplied
1020
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig] parsed result object
1021
+ # @yieldparam err [StandardError] error object if request failed
1022
+ #
1023
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig]
1024
+ #
1025
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1026
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1027
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1028
+ def get_project_app_recaptcha_enterprise_config(name, fields: nil, quota_user: nil, options: nil, &block)
1029
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1030
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig::Representation
1031
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig
1032
+ command.params['name'] = name unless name.nil?
1033
+ command.query['fields'] = fields unless fields.nil?
1034
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1035
+ execute_or_queue_command(command, &block)
1036
+ end
1037
+
1038
+ # Updates the RecaptchaEnterpriseConfig for the specified app. While this
1039
+ # configuration is incomplete or invalid, the app will be unable to exchange
1040
+ # reCAPTCHA Enterprise tokens for App Check tokens.
1041
+ # @param [String] name
1042
+ # Required. The relative resource name of the reCAPTCHA Enterprise configuration
1043
+ # object, in the format: ``` projects/`project_number`/apps/`app_id`/
1044
+ # recaptchaEnterpriseConfig ```
1045
+ # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig] google_firebase_appcheck_v1beta_recaptcha_enterprise_config_object
1046
+ # @param [String] update_mask
1047
+ # Required. A comma-separated list of names of fields in the
1048
+ # RecaptchaEnterpriseConfig to update. Example: `site_key`.
1049
+ # @param [String] fields
1050
+ # Selector specifying which fields to include in a partial response.
1051
+ # @param [String] quota_user
1052
+ # Available to use for quota purposes for server-side applications. Can be any
1053
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1054
+ # @param [Google::Apis::RequestOptions] options
1055
+ # Request-specific options
1056
+ #
1057
+ # @yield [result, err] Result & error if block supplied
1058
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig] parsed result object
1059
+ # @yieldparam err [StandardError] error object if request failed
1060
+ #
1061
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig]
1062
+ #
1063
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1064
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1065
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1066
+ def patch_project_app_recaptcha_enterprise_config(name, google_firebase_appcheck_v1beta_recaptcha_enterprise_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1067
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1068
+ command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig::Representation
1069
+ command.request_object = google_firebase_appcheck_v1beta_recaptcha_enterprise_config_object
1070
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig::Representation
1071
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig
1072
+ command.params['name'] = name unless name.nil?
1073
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1074
+ command.query['fields'] = fields unless fields.nil?
1075
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1076
+ execute_or_queue_command(command, &block)
1077
+ end
1078
+
1079
+ # Atomically gets the SafetyNetConfigs for the specified list of apps.
928
1080
  # @param [String] parent
929
1081
  # Required. The parent project name shared by all SafetyNetConfigs being
930
1082
  # retrieved, in the format ``` projects/`project_number` ``` The parent
@@ -1033,7 +1185,7 @@ module Google
1033
1185
  execute_or_queue_command(command, &block)
1034
1186
  end
1035
1187
 
1036
- # Updates the specified Service configurations atomically.
1188
+ # Atomically updates the specified Service configurations.
1037
1189
  # @param [String] parent
1038
1190
  # Required. The parent project name shared by all Service configurations being
1039
1191
  # updated, in the format ``` projects/`project_number` ``` The parent collection
@@ -21,18 +21,8 @@ module Google
21
21
  module Apis
22
22
  # Firebase App Check API
23
23
  #
24
- # App Check works alongside other Firebase services to help protect your backend
25
- # resources from abuse, such as billing fraud or phishing. With App Check,
26
- # devices running your app will use an app or device attestation provider that
27
- # attests to one or both of the following: * Requests originate from your
28
- # authentic app * Requests originate from an authentic, untampered device This
29
- # attestation is attached to every request your app makes to your Firebase
30
- # backend resources. The Firebase App Check REST API allows you to manage your
31
- # App Check configurations programmatically. It also allows you to exchange
32
- # attestation material for App Check tokens directly without using a Firebase
33
- # SDK. Finally, it allows you to obtain the public key set necessary to validate
34
- # an App Check token yourself. [Learn more about App Check](https://firebase.
35
- # google.com/docs/app-check).
24
+ # Firebase App Check works alongside other Firebase services to help protect
25
+ # your backend resources from abuse, such as billing fraud or phishing.
36
26
  #
37
27
  # @see https://firebase.google.com/docs/app-check
38
28
  module FirebaseappcheckV1beta
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-firebaseappcheck_v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.0
4
+ version: 0.11.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-10-04 00:00:00.000000000 Z
11
+ date: 2022-01-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -57,9 +57,9 @@ licenses:
57
57
  - Apache-2.0
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
- changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-firebaseappcheck_v1beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-firebaseappcheck_v1beta/v0.7.0
62
- source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-firebaseappcheck_v1beta
60
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firebaseappcheck_v1beta/CHANGELOG.md
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-firebaseappcheck_v1beta/v0.11.0
62
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firebaseappcheck_v1beta
63
63
  post_install_message:
64
64
  rdoc_options: []
65
65
  require_paths:
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.2.17
78
+ rubygems_version: 3.3.5
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Firebase App Check API V1beta