google-apis-firebaseappcheck_v1beta 0.5.0 → 0.9.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: a45c368a19f5db8386e290d518ead660d3a2ddeeb8a668b8bb2ff940e58aa16c
4
- data.tar.gz: 41850a84c3f1b35e514e79e1e0ad8f26d0e8b348bbb32af8e56463854dad5fde
3
+ metadata.gz: bf5ad702332e4ce19ee1a630b05c456ee46e7536f5b57611c92ec3f92d113eed
4
+ data.tar.gz: 29924930596201964690e077d64ae0d629d01362e68ed378f66526e46a8e00ff
5
5
  SHA512:
6
- metadata.gz: 8a40e38419e2f756176f08733f11776ce907826108e48ba6e0b4603b3434f1d51d61fcd4bd701ac5abfda3c528904d681a3d9eed55370b10db6bb13190b115ce
7
- data.tar.gz: 96b23cd8ea24a50c22ad7373125d3478b060e78bd7b2396cfa49741678570d4e8fd1b77a7743ada440312d6e5246015783e2eae59aac7553187aa276da754199
6
+ metadata.gz: 7c0a0e407d3b9132a5e5dc7457b3bf94da376a1a6a7eedf965e92049d253a25689422604568814fa58f4874e6f3850534214c222ba022ec6a5f4ece4f1a17803
7
+ data.tar.gz: 066d35c896d488cfa68f8de59d89b9e9d10bb782339f7096db2d64cd670e5e6e4d717ae18e8f059627cc54956d2e154b13b67c9189644d2fe952e3ee1e1591c6
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Release history for google-apis-firebaseappcheck_v1beta
2
2
 
3
+ ### v0.9.0 (2021-11-01)
4
+
5
+ * Regenerated from discovery document revision 20211029
6
+
7
+ ### v0.8.0 (2021-10-20)
8
+
9
+ * Regenerated from discovery document revision 20211015
10
+
11
+ ### v0.7.0 (2021-09-29)
12
+
13
+ * Regenerated from discovery document revision 20210924
14
+
15
+ ### v0.6.0 (2021-09-15)
16
+
17
+ * Regenerated from discovery document revision 20210910
18
+
3
19
  ### v0.5.0 (2021-08-18)
4
20
 
5
21
  * Regenerated from discovery document revision 20210813
data/OVERVIEW.md CHANGED
@@ -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,25 +392,25 @@ 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
- # The App Attest statement as returned by Apple's client-side App Attest API.
380
- # This is the CBOR object returned by Apple, which will be Base64 encoded in the
381
- # 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
- # 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]
391
411
  attr_accessor :challenge
392
412
 
393
- # The key ID generated by App Attest for the client app.
413
+ # Required. The key ID generated by App Attest for the client app.
394
414
  # Corresponds to the JSON property `keyId`
395
415
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
396
416
  # @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]
@@ -440,7 +459,7 @@ module Google
440
459
  class GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest
441
460
  include Google::Apis::Core::Hashable
442
461
 
443
- # A custom token signed using your project's Admin SDK service account
462
+ # Required. A custom token signed using your project's Admin SDK service account
444
463
  # credentials.
445
464
  # Corresponds to the JSON property `customToken`
446
465
  # @return [String]
@@ -460,8 +479,8 @@ module Google
460
479
  class GoogleFirebaseAppcheckV1betaExchangeDebugTokenRequest
461
480
  include Google::Apis::Core::Hashable
462
481
 
463
- # A debug token secret. This string must match a debug token secret previously
464
- # created using CreateDebugToken.
482
+ # Required. A debug token secret. This string must match a debug token secret
483
+ # previously created using CreateDebugToken.
465
484
  # Corresponds to the JSON property `debugToken`
466
485
  # @return [String]
467
486
  attr_accessor :debug_token
@@ -480,9 +499,9 @@ module Google
480
499
  class GoogleFirebaseAppcheckV1betaExchangeDeviceCheckTokenRequest
481
500
  include Google::Apis::Core::Hashable
482
501
 
483
- # The `device_token` as returned by Apple's client-side [DeviceCheck API](https:/
484
- # /developer.apple.com/documentation/devicecheck/dcdevice). This is the Base64
485
- # encoded `Data` (Swift) or `NSData` (ObjC) object.
502
+ # Required. The `device_token` as returned by Apple's client-side [DeviceCheck
503
+ # API](https://developer.apple.com/documentation/devicecheck/dcdevice). This is
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,12 +516,33 @@ 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
503
543
 
504
- # The reCAPTCHA token as returned by the [reCAPTCHA v3 JavaScript API](https://
505
- # developers.google.com/recaptcha/docs/v3).
544
+ # Required. The reCAPTCHA token as returned by the [reCAPTCHA v3 JavaScript API](
545
+ # https://developers.google.com/recaptcha/docs/v3).
506
546
  # Corresponds to the JSON property `recaptchaToken`
507
547
  # @return [String]
508
548
  attr_accessor :recaptcha_token
@@ -521,8 +561,8 @@ module Google
521
561
  class GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest
522
562
  include Google::Apis::Core::Hashable
523
563
 
524
- # The [SafetyNet attestation response](https://developer.android.com/training/
525
- # safetynet/attestation#request-attestation-step) issued to your app.
564
+ # Required. The [SafetyNet attestation response](https://developer.android.com/
565
+ # training/safetynet/attestation#request-attestation-step) issued to your app.
526
566
  # Corresponds to the JSON property `safetyNetToken`
527
567
  # @return [String]
528
568
  attr_accessor :safety_net_token
@@ -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
@@ -780,7 +863,7 @@ module Google
780
863
  # the `service_id` element must be a supported service ID. Currently, the
781
864
  # following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud
782
865
  # Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime
783
- # Database)
866
+ # Database) * `firestore.googleapis.com` (Cloud Firestore)
784
867
  # Corresponds to the JSON property `name`
785
868
  # @return [String]
786
869
  attr_accessor :name
@@ -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.5.0"
19
+ GEM_VERSION = "0.9.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210813"
25
+ REVISION = "20211029"
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,19 @@ 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 the
127
+ # developer's preconfigured team and bundle IDs. If valid, returns an
128
+ # attestation artifact that can later be exchanged for an
129
+ # AttestationTokenResponse using ExchangeAppAttestAssertion. For convenience and
130
+ # performance, this method's response object will also contain an App Check
131
+ # token encapsulated in an AttestationTokenResponse (if the verification is
132
+ # successful).
138
133
  # @param [String] app
139
- # Required. The full resource name to the iOS App. Format: "projects/`project_id`
140
- # /apps/`app_id`"
134
+ # Required. The relative resource name of the iOS app, in the format: ```
135
+ # projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
136
+ # element can be replaced with the project ID of the Firebase project. Learn
137
+ # more about using project identifiers in Google's [AIP 2510](https://google.aip.
138
+ # dev/cloud/2510) standard.
141
139
  # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest] google_firebase_appcheck_v1beta_exchange_app_attest_attestation_request_object
142
140
  # @param [String] fields
143
141
  # Selector specifying which fields to include in a partial response.
@@ -287,6 +285,45 @@ module Google
287
285
  execute_or_queue_command(command, &block)
288
286
  end
289
287
 
288
+ # Validates a [reCAPTCHA Enterprise response token](https://cloud.google.com/
289
+ # recaptcha-enterprise/docs/create-assessment#retrieve_token). If valid, returns
290
+ # an App Check token encapsulated in an AttestationTokenResponse.
291
+ # @param [String] app
292
+ # Required. The relative resource name of the web app, in the format: ```
293
+ # projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
294
+ # element can be replaced with the project ID of the Firebase project. Learn
295
+ # more about using project identifiers in Google's [AIP 2510](https://google.aip.
296
+ # dev/cloud/2510) standard.
297
+ # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest] google_firebase_appcheck_v1beta_exchange_recaptcha_enterprise_token_request_object
298
+ # @param [String] fields
299
+ # Selector specifying which fields to include in a partial response.
300
+ # @param [String] quota_user
301
+ # Available to use for quota purposes for server-side applications. Can be any
302
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
303
+ # @param [Google::Apis::RequestOptions] options
304
+ # Request-specific options
305
+ #
306
+ # @yield [result, err] Result & error if block supplied
307
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse] parsed result object
308
+ # @yieldparam err [StandardError] error object if request failed
309
+ #
310
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse]
311
+ #
312
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
313
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
314
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
315
+ 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)
316
+ command = make_simple_command(:post, 'v1beta/{+app}:exchangeRecaptchaEnterpriseToken', options)
317
+ command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest::Representation
318
+ command.request_object = google_firebase_appcheck_v1beta_exchange_recaptcha_enterprise_token_request_object
319
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse::Representation
320
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse
321
+ command.params['app'] = app unless app.nil?
322
+ command.query['fields'] = fields unless fields.nil?
323
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
324
+ execute_or_queue_command(command, &block)
325
+ end
326
+
290
327
  # Validates a [reCAPTCHA v3 response token](https://developers.google.com/
291
328
  # recaptcha/docs/v3). If valid, returns an App Check token encapsulated in an
292
329
  # AttestationTokenResponse.
@@ -365,11 +402,15 @@ module Google
365
402
  execute_or_queue_command(command, &block)
366
403
  end
367
404
 
368
- # Initiates the App Attest flow by generating a challenge which will be used as
369
- # a type of nonce for this attestation.
405
+ # Generates a challenge that protects the integrity of an immediately following
406
+ # call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A
407
+ # challenge should not be reused for multiple calls.
370
408
  # @param [String] app
371
- # Required. The full resource name to the iOS App. Format: "projects/`project_id`
372
- # /apps/`app_id`"
409
+ # Required. The relative resource name of the iOS app, in the format: ```
410
+ # projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
411
+ # element can be replaced with the project ID of the Firebase project. Learn
412
+ # more about using project identifiers in Google's [AIP 2510](https://google.aip.
413
+ # dev/cloud/2510) standard.
373
414
  # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest] google_firebase_appcheck_v1beta_generate_app_attest_challenge_request_object
374
415
  # @param [String] fields
375
416
  # Selector specifying which fields to include in a partial response.
@@ -663,8 +704,8 @@ module Google
663
704
  # cannot be updated, nor will it be populated in the response, but you can
664
705
  # revoke the debug token using DeleteDebugToken.
665
706
  # @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` ```
707
+ # Required. The relative resource name of the debug token, in the format: ```
708
+ # projects/`project_number`/apps/`app_id`/debugTokens/`debug_token_id` ```
668
709
  # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaDebugToken] google_firebase_appcheck_v1beta_debug_token_object
669
710
  # @param [String] update_mask
670
711
  # Required. A comma-separated list of names of fields in the DebugToken to
@@ -924,6 +965,118 @@ module Google
924
965
  execute_or_queue_command(command, &block)
925
966
  end
926
967
 
968
+ # Gets the RecaptchaEnterpriseConfigs for the specified list of apps atomically.
969
+ # @param [String] parent
970
+ # Required. The parent project name shared by all RecaptchaEnterpriseConfigs
971
+ # being retrieved, in the format ``` projects/`project_number` ``` The parent
972
+ # collection in the `name` field of any resource being retrieved must match this
973
+ # field, or the entire batch fails.
974
+ # @param [Array<String>, String] names
975
+ # Required. The relative resource names of the RecaptchaEnterpriseConfigs to
976
+ # retrieve, in the format: ``` projects/`project_number`/apps/`app_id`/
977
+ # recaptchaEnterpriseConfig ``` A maximum of 100 objects can be retrieved in a
978
+ # batch.
979
+ # @param [String] fields
980
+ # Selector specifying which fields to include in a partial response.
981
+ # @param [String] quota_user
982
+ # Available to use for quota purposes for server-side applications. Can be any
983
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
984
+ # @param [Google::Apis::RequestOptions] options
985
+ # Request-specific options
986
+ #
987
+ # @yield [result, err] Result & error if block supplied
988
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse] parsed result object
989
+ # @yieldparam err [StandardError] error object if request failed
990
+ #
991
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse]
992
+ #
993
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
994
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
995
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
996
+ def batch_project_app_recaptcha_enterprise_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
997
+ command = make_simple_command(:get, 'v1beta/{+parent}/apps/-/recaptchaEnterpriseConfig:batchGet', options)
998
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse::Representation
999
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse
1000
+ command.params['parent'] = parent unless parent.nil?
1001
+ command.query['names'] = names unless names.nil?
1002
+ command.query['fields'] = fields unless fields.nil?
1003
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1004
+ execute_or_queue_command(command, &block)
1005
+ end
1006
+
1007
+ # Gets the RecaptchaEnterpriseConfig for the specified app.
1008
+ # @param [String] name
1009
+ # Required. The relative resource name of the RecaptchaEnterpriseConfig, in the
1010
+ # format: ``` projects/`project_number`/apps/`app_id`/recaptchaEnterpriseConfig `
1011
+ # ``
1012
+ # @param [String] fields
1013
+ # Selector specifying which fields to include in a partial response.
1014
+ # @param [String] quota_user
1015
+ # Available to use for quota purposes for server-side applications. Can be any
1016
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1017
+ # @param [Google::Apis::RequestOptions] options
1018
+ # Request-specific options
1019
+ #
1020
+ # @yield [result, err] Result & error if block supplied
1021
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig] parsed result object
1022
+ # @yieldparam err [StandardError] error object if request failed
1023
+ #
1024
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig]
1025
+ #
1026
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1027
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1028
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1029
+ def get_project_app_recaptcha_enterprise_config(name, fields: nil, quota_user: nil, options: nil, &block)
1030
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1031
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig::Representation
1032
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig
1033
+ command.params['name'] = name unless name.nil?
1034
+ command.query['fields'] = fields unless fields.nil?
1035
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1036
+ execute_or_queue_command(command, &block)
1037
+ end
1038
+
1039
+ # Updates the RecaptchaEnterpriseConfig for the specified app. While this
1040
+ # configuration is incomplete or invalid, the app will be unable to exchange
1041
+ # reCAPTCHA Enterprise tokens for App Check tokens.
1042
+ # @param [String] name
1043
+ # Required. The relative resource name of the reCAPTCHA Enterprise configuration
1044
+ # object, in the format: ``` projects/`project_number`/apps/`app_id`/
1045
+ # recaptchaEnterpriseConfig ```
1046
+ # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig] google_firebase_appcheck_v1beta_recaptcha_enterprise_config_object
1047
+ # @param [String] update_mask
1048
+ # Required. A comma-separated list of names of fields in the
1049
+ # RecaptchaEnterpriseConfig to update. Example: `site_key`.
1050
+ # @param [String] fields
1051
+ # Selector specifying which fields to include in a partial response.
1052
+ # @param [String] quota_user
1053
+ # Available to use for quota purposes for server-side applications. Can be any
1054
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1055
+ # @param [Google::Apis::RequestOptions] options
1056
+ # Request-specific options
1057
+ #
1058
+ # @yield [result, err] Result & error if block supplied
1059
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig] parsed result object
1060
+ # @yieldparam err [StandardError] error object if request failed
1061
+ #
1062
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig]
1063
+ #
1064
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1065
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1066
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1067
+ 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)
1068
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1069
+ command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig::Representation
1070
+ command.request_object = google_firebase_appcheck_v1beta_recaptcha_enterprise_config_object
1071
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig::Representation
1072
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig
1073
+ command.params['name'] = name unless name.nil?
1074
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1075
+ command.query['fields'] = fields unless fields.nil?
1076
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1077
+ execute_or_queue_command(command, &block)
1078
+ end
1079
+
927
1080
  # Gets the SafetyNetConfigs for the specified list of apps atomically.
928
1081
  # @param [String] parent
929
1082
  # Required. The parent project name shared by all SafetyNetConfigs being
@@ -1076,6 +1229,7 @@ module Google
1076
1229
  # service_id` element must be a supported service ID. Currently, the following
1077
1230
  # service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage
1078
1231
  # for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database)
1232
+ # * `firestore.googleapis.com` (Cloud Firestore)
1079
1233
  # @param [String] fields
1080
1234
  # Selector specifying which fields to include in a partial response.
1081
1235
  # @param [String] quota_user
@@ -1156,7 +1310,7 @@ module Google
1156
1310
  # the `service_id` element must be a supported service ID. Currently, the
1157
1311
  # following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud
1158
1312
  # Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime
1159
- # Database)
1313
+ # Database) * `firestore.googleapis.com` (Cloud Firestore)
1160
1314
  # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaService] google_firebase_appcheck_v1beta_service_object
1161
1315
  # @param [String] update_mask
1162
1316
  # Required. A comma-separated list of names of fields in the Service to update.
@@ -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.5.0
4
+ version: 0.9.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-08-23 00:00:00.000000000 Z
11
+ date: 2021-11-08 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.5.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.9.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: