google-cloud-recaptcha_enterprise-v1 0.15.0 → 0.17.3

Sign up to get free protection for your applications and to get access to all the features.
@@ -25,7 +25,7 @@ module Google
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
27
  # Required. The name of the project in which the assessment will be created,
28
- # in the format "projects/\\{project}".
28
+ # in the format `projects/{project}`.
29
29
  # @!attribute [rw] assessment
30
30
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::Assessment]
31
31
  # Required. The assessment details.
@@ -159,7 +159,7 @@ module Google
159
159
  # @!attribute [rw] name
160
160
  # @return [::String]
161
161
  # Required. The resource name of the Assessment, in the format
162
- # "projects/\\{project}/assessments/\\{assessment}".
162
+ # `projects/{project}/assessments/{assessment}`.
163
163
  # @!attribute [rw] annotation
164
164
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation]
165
165
  # Optional. The annotation that will be assigned to the Event. This field can
@@ -167,15 +167,18 @@ module Google
167
167
  # whether the event is legitimate or fraudulent.
168
168
  # @!attribute [rw] reasons
169
169
  # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>]
170
- # Optional. Optional reasons for the annotation that will be assigned to the
171
- # Event.
170
+ # Optional. Reasons for the annotation that are assigned to the event.
171
+ # @!attribute [rw] account_id
172
+ # @return [::String]
173
+ # Optional. A stable account identifier to apply to the assessment. This is
174
+ # an alternative to setting `account_id` in `CreateAssessment`, for example
175
+ # when a stable account identifier is not yet known in the initial request.
172
176
  # @!attribute [rw] hashed_account_id
173
177
  # @return [::String]
174
- # Optional. Unique stable hashed user identifier to apply to the assessment.
175
- # This is an alternative to setting the hashed_account_id in
176
- # CreateAssessment, for example when the account identifier is not yet known
177
- # in the initial request. It is recommended that the identifier is hashed
178
- # using hmac-sha256 with stable secret.
178
+ # Optional. A stable hashed account identifier to apply to the assessment.
179
+ # This is an alternative to setting `hashed_account_id` in
180
+ # `CreateAssessment`, for example when a stable account identifier is not yet
181
+ # known in the initial request.
179
182
  # @!attribute [rw] transaction_event
180
183
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent]
181
184
  # Optional. If the assessment is part of a payment transaction, provide
@@ -302,18 +305,19 @@ module Google
302
305
  # Information about account verification, used for identity verification.
303
306
  # @!attribute [rw] endpoints
304
307
  # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::EndpointVerificationInfo>]
305
- # Endpoints that can be used for identity verification.
308
+ # Optional. Endpoints that can be used for identity verification.
306
309
  # @!attribute [rw] language_code
307
310
  # @return [::String]
308
- # Language code preference for the verification message, set as a IETF BCP 47
309
- # language code.
311
+ # Optional. Language code preference for the verification message, set as a
312
+ # IETF BCP 47 language code.
310
313
  # @!attribute [r] latest_verification_result
311
314
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::AccountVerificationInfo::Result]
312
315
  # Output only. Result of the latest account verification challenge.
313
316
  # @!attribute [rw] username
317
+ # @deprecated This field is deprecated and may be removed in the next major version update.
314
318
  # @return [::String]
315
319
  # Username of the account that is being verified. Deprecated. Customers
316
- # should now provide the hashed account ID field in Event.
320
+ # should now provide the `account_id` field in `event.user_info`.
317
321
  class AccountVerificationInfo
318
322
  include ::Google::Protobuf::MessageExts
319
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -365,7 +369,7 @@ module Google
365
369
  # Private password leak verification info.
366
370
  # @!attribute [rw] lookup_hash_prefix
367
371
  # @return [::String]
368
- # Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized
372
+ # Required. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized
369
373
  # username. It is used to look up password leaks associated with that hash
370
374
  # prefix.
371
375
  # @!attribute [rw] encrypted_user_credentials_hash
@@ -391,11 +395,11 @@ module Google
391
395
  # A reCAPTCHA Enterprise assessment resource.
392
396
  # @!attribute [r] name
393
397
  # @return [::String]
394
- # Output only. The resource name for the Assessment in the format
395
- # "projects/\\{project}/assessments/\\{assessment}".
398
+ # Output only. Identifier. The resource name for the Assessment in the format
399
+ # `projects/{project}/assessments/{assessment}`.
396
400
  # @!attribute [rw] event
397
401
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::Event]
398
- # The event being assessed.
402
+ # Optional. The event being assessed.
399
403
  # @!attribute [r] risk_analysis
400
404
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::RiskAnalysis]
401
405
  # Output only. The risk analysis result for the event being assessed.
@@ -404,19 +408,29 @@ module Google
404
408
  # Output only. Properties of the provided event token.
405
409
  # @!attribute [rw] account_verification
406
410
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::AccountVerificationInfo]
407
- # Account verification information for identity verification. The assessment
408
- # event must include a token and site key to use this feature.
409
- # @!attribute [rw] account_defender_assessment
411
+ # Optional. Account verification information for identity verification. The
412
+ # assessment event must include a token and site key to use this feature.
413
+ # @!attribute [r] account_defender_assessment
410
414
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::AccountDefenderAssessment]
411
- # Assessment returned by account defender when a hashed_account_id is
412
- # provided.
415
+ # Output only. Assessment returned by account defender when an account
416
+ # identifier is provided.
413
417
  # @!attribute [rw] private_password_leak_verification
414
418
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::PrivatePasswordLeakVerification]
415
- # The private password leak verification field contains the parameters that
416
- # are used to to check for leaks privately without sharing user credentials.
417
- # @!attribute [rw] fraud_prevention_assessment
419
+ # Optional. The private password leak verification field contains the
420
+ # parameters that are used to to check for leaks privately without sharing
421
+ # user credentials.
422
+ # @!attribute [r] firewall_policy_assessment
423
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicyAssessment]
424
+ # Output only. Assessment returned when firewall policies belonging to the
425
+ # project are evaluated using the field firewall_policy_evaluation.
426
+ # @!attribute [r] fraud_prevention_assessment
418
427
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::FraudPreventionAssessment]
419
- # Assessment returned by Fraud Prevention when TransactionData is provided.
428
+ # Output only. Assessment returned by Fraud Prevention when TransactionData
429
+ # is provided.
430
+ # @!attribute [r] fraud_signals
431
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FraudSignals]
432
+ # Output only. Fraud Signals specific to the users involved in a payment
433
+ # transaction.
420
434
  class Assessment
421
435
  include ::Google::Protobuf::MessageExts
422
436
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -445,21 +459,52 @@ module Google
445
459
  # same action provided at token generation time on client-side platforms
446
460
  # already integrated with recaptcha enterprise.
447
461
  # @!attribute [rw] hashed_account_id
462
+ # @deprecated This field is deprecated and may be removed in the next major version update.
463
+ # @return [::String]
464
+ # Optional. Deprecated: use `user_info.account_id` instead.
465
+ # Unique stable hashed user identifier for the request. The identifier must
466
+ # be hashed using hmac-sha256 with stable secret.
467
+ # @!attribute [rw] express
468
+ # @return [::Boolean]
469
+ # Optional. Flag for a reCAPTCHA express request for an assessment without a
470
+ # token. If enabled, `site_key` must reference a SCORE key with WAF feature
471
+ # set to EXPRESS.
472
+ # @!attribute [rw] requested_uri
473
+ # @return [::String]
474
+ # Optional. The URI resource the user requested that triggered an assessment.
475
+ # @!attribute [rw] waf_token_assessment
476
+ # @return [::Boolean]
477
+ # Optional. Flag for running WAF token assessment.
478
+ # If enabled, the token must be specified, and have been created by a
479
+ # WAF-enabled key.
480
+ # @!attribute [rw] ja3
448
481
  # @return [::String]
449
- # Optional. Unique stable hashed user identifier for the request. The
450
- # identifier must be hashed using hmac-sha256 with stable secret.
482
+ # Optional. JA3 fingerprint for SSL clients.
483
+ # @!attribute [rw] headers
484
+ # @return [::Array<::String>]
485
+ # Optional. HTTP header information about the request.
486
+ # @!attribute [rw] firewall_policy_evaluation
487
+ # @return [::Boolean]
488
+ # Optional. Flag for enabling firewall policy config assessment.
489
+ # If this flag is enabled, the firewall policy will be evaluated and a
490
+ # suggested firewall action will be returned in the response.
451
491
  # @!attribute [rw] transaction_data
452
492
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData]
453
493
  # Optional. Data describing a payment transaction to be assessed. Sending
454
494
  # this data enables reCAPTCHA Enterprise Fraud Prevention and the
455
495
  # FraudPreventionAssessment component in the response.
496
+ # @!attribute [rw] user_info
497
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::UserInfo]
498
+ # Optional. Information about the user that generates this event, when they
499
+ # can be identified. They are often identified through the use of an account
500
+ # for logged-in requests or login/registration requests, or by providing user
501
+ # identifiers for guest actions like checkout.
456
502
  class Event
457
503
  include ::Google::Protobuf::MessageExts
458
504
  extend ::Google::Protobuf::MessageExts::ClassMethods
459
505
  end
460
506
 
461
507
  # Transaction data associated with a payment protected by reCAPTCHA Enterprise.
462
- # All fields are optional.
463
508
  # @!attribute [rw] transaction_id
464
509
  # @return [::String]
465
510
  # Unique identifier for the transaction. This custom identifier can be used
@@ -468,7 +513,7 @@ module Google
468
513
  # same transaction id.
469
514
  # @!attribute [rw] payment_method
470
515
  # @return [::String]
471
- # The payment method for the transaction. The allowed values are:
516
+ # Optional. The payment method for the transaction. The allowed values are:
472
517
  #
473
518
  # * credit-card
474
519
  # * debit-card
@@ -479,38 +524,41 @@ module Google
479
524
  # custom-crypto)
480
525
  # @!attribute [rw] card_bin
481
526
  # @return [::String]
482
- # The Bank Identification Number - generally the first 6 or 8 digits of the
483
- # card.
527
+ # Optional. The Bank Identification Number - generally the first 6 or 8
528
+ # digits of the card.
484
529
  # @!attribute [rw] card_last_four
485
530
  # @return [::String]
486
- # The last four digits of the card.
531
+ # Optional. The last four digits of the card.
487
532
  # @!attribute [rw] currency_code
488
533
  # @return [::String]
489
- # The currency code in ISO-4217 format.
534
+ # Optional. The currency code in ISO-4217 format.
490
535
  # @!attribute [rw] value
491
536
  # @return [::Float]
492
- # The decimal value of the transaction in the specified currency.
537
+ # Optional. The decimal value of the transaction in the specified currency.
493
538
  # @!attribute [rw] shipping_value
494
539
  # @return [::Float]
495
- # The value of shipping in the specified currency. 0 for free or no shipping.
540
+ # Optional. The value of shipping in the specified currency. 0 for free or no
541
+ # shipping.
496
542
  # @!attribute [rw] shipping_address
497
543
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::Address]
498
- # Destination address if this transaction involves shipping a physical item.
544
+ # Optional. Destination address if this transaction involves shipping a
545
+ # physical item.
499
546
  # @!attribute [rw] billing_address
500
547
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::Address]
501
- # Address associated with the payment method when applicable.
548
+ # Optional. Address associated with the payment method when applicable.
502
549
  # @!attribute [rw] user
503
550
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::User]
504
- # Information about the user paying/initiating the transaction.
551
+ # Optional. Information about the user paying/initiating the transaction.
505
552
  # @!attribute [rw] merchants
506
553
  # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::User>]
507
- # Information about the user or users fulfilling the transaction.
554
+ # Optional. Information about the user or users fulfilling the transaction.
508
555
  # @!attribute [rw] items
509
556
  # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::Item>]
510
- # Items purchased in this transaction.
557
+ # Optional. Items purchased in this transaction.
511
558
  # @!attribute [rw] gateway_info
512
559
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::GatewayInfo]
513
- # Information about the payment gateway's response to the transaction.
560
+ # Optional. Information about the payment gateway's response to the
561
+ # transaction.
514
562
  class TransactionData
515
563
  include ::Google::Protobuf::MessageExts
516
564
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -518,24 +566,26 @@ module Google
518
566
  # Structured address format for billing and shipping addresses.
519
567
  # @!attribute [rw] recipient
520
568
  # @return [::String]
521
- # The recipient name, potentially including information such as "care of".
569
+ # Optional. The recipient name, potentially including information such as
570
+ # "care of".
522
571
  # @!attribute [rw] address
523
572
  # @return [::Array<::String>]
524
- # The first lines of the address. The first line generally contains the
525
- # street name and number, and further lines may include information such as
526
- # an apartment number.
573
+ # Optional. The first lines of the address. The first line generally
574
+ # contains the street name and number, and further lines may include
575
+ # information such as an apartment number.
527
576
  # @!attribute [rw] locality
528
577
  # @return [::String]
529
- # The town/city of the address.
578
+ # Optional. The town/city of the address.
530
579
  # @!attribute [rw] administrative_area
531
580
  # @return [::String]
532
- # The state, province, or otherwise administrative area of the address.
581
+ # Optional. The state, province, or otherwise administrative area of the
582
+ # address.
533
583
  # @!attribute [rw] region_code
534
584
  # @return [::String]
535
- # The CLDR country/region of the address.
585
+ # Optional. The CLDR country/region of the address.
536
586
  # @!attribute [rw] postal_code
537
587
  # @return [::String]
538
- # The postal or ZIP code of the address.
588
+ # Optional. The postal or ZIP code of the address.
539
589
  class Address
540
590
  include ::Google::Protobuf::MessageExts
541
591
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -544,26 +594,26 @@ module Google
544
594
  # Details about a user's account involved in the transaction.
545
595
  # @!attribute [rw] account_id
546
596
  # @return [::String]
547
- # Unique account identifier for this user. If using account defender,
548
- # this should match the hashed_account_id field. Otherwise, a unique and
549
- # persistent identifier for this account.
597
+ # Optional. Unique account identifier for this user. If using account
598
+ # defender, this should match the hashed_account_id field. Otherwise, a
599
+ # unique and persistent identifier for this account.
550
600
  # @!attribute [rw] creation_ms
551
601
  # @return [::Integer]
552
- # The epoch milliseconds of the user's account creation.
602
+ # Optional. The epoch milliseconds of the user's account creation.
553
603
  # @!attribute [rw] email
554
604
  # @return [::String]
555
- # The email address of the user.
605
+ # Optional. The email address of the user.
556
606
  # @!attribute [rw] email_verified
557
607
  # @return [::Boolean]
558
- # Whether the email has been verified to be accessible by the user (OTP or
559
- # similar).
608
+ # Optional. Whether the email has been verified to be accessible by the
609
+ # user (OTP or similar).
560
610
  # @!attribute [rw] phone_number
561
611
  # @return [::String]
562
- # The phone number of the user, with country code.
612
+ # Optional. The phone number of the user, with country code.
563
613
  # @!attribute [rw] phone_verified
564
614
  # @return [::Boolean]
565
- # Whether the phone number has been verified to be accessible by the user
566
- # (OTP or similar).
615
+ # Optional. Whether the phone number has been verified to be accessible by
616
+ # the user (OTP or similar).
567
617
  class User
568
618
  include ::Google::Protobuf::MessageExts
569
619
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -572,18 +622,18 @@ module Google
572
622
  # Line items being purchased in this transaction.
573
623
  # @!attribute [rw] name
574
624
  # @return [::String]
575
- # The full name of the item.
625
+ # Optional. The full name of the item.
576
626
  # @!attribute [rw] value
577
627
  # @return [::Float]
578
- # The value per item that the user is paying, in the transaction currency,
579
- # after discounts.
628
+ # Optional. The value per item that the user is paying, in the transaction
629
+ # currency, after discounts.
580
630
  # @!attribute [rw] quantity
581
631
  # @return [::Integer]
582
- # The quantity of this item that is being purchased.
632
+ # Optional. The quantity of this item that is being purchased.
583
633
  # @!attribute [rw] merchant_account_id
584
634
  # @return [::String]
585
- # When a merchant is specified, its corresponding account_id. Necessary to
586
- # populate marketplace-style transactions.
635
+ # Optional. When a merchant is specified, its corresponding account_id.
636
+ # Necessary to populate marketplace-style transactions.
587
637
  class Item
588
638
  include ::Google::Protobuf::MessageExts
589
639
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -592,17 +642,18 @@ module Google
592
642
  # Details about the transaction from the gateway.
593
643
  # @!attribute [rw] name
594
644
  # @return [::String]
595
- # Name of the gateway service (for example, stripe, square, paypal).
645
+ # Optional. Name of the gateway service (for example, stripe, square,
646
+ # paypal).
596
647
  # @!attribute [rw] gateway_response_code
597
648
  # @return [::String]
598
- # Gateway response code describing the state of the transaction.
649
+ # Optional. Gateway response code describing the state of the transaction.
599
650
  # @!attribute [rw] avs_response_code
600
651
  # @return [::String]
601
- # AVS response code from the gateway
652
+ # Optional. AVS response code from the gateway
602
653
  # (available only when reCAPTCHA Enterprise is called after authorization).
603
654
  # @!attribute [rw] cvv_response_code
604
655
  # @return [::String]
605
- # CVV response code from the gateway
656
+ # Optional. CVV response code from the gateway
606
657
  # (available only when reCAPTCHA Enterprise is called after authorization).
607
658
  class GatewayInfo
608
659
  include ::Google::Protobuf::MessageExts
@@ -610,15 +661,57 @@ module Google
610
661
  end
611
662
  end
612
663
 
664
+ # User information associated with a request protected by reCAPTCHA Enterprise.
665
+ # @!attribute [rw] create_account_time
666
+ # @return [::Google::Protobuf::Timestamp]
667
+ # Optional. Creation time for this account associated with this user. Leave
668
+ # blank for non logged-in actions, guest checkout, or when there is no
669
+ # account associated with the current user.
670
+ # @!attribute [rw] account_id
671
+ # @return [::String]
672
+ # Optional. For logged-in requests or login/registration requests, the unique
673
+ # account identifier associated with this user. You can use the username if
674
+ # it is stable (meaning it is the same for every request associated with the
675
+ # same user), or any stable user ID of your choice. Leave blank for non
676
+ # logged-in actions or guest checkout.
677
+ # @!attribute [rw] user_ids
678
+ # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::UserId>]
679
+ # Optional. Identifiers associated with this user or request.
680
+ class UserInfo
681
+ include ::Google::Protobuf::MessageExts
682
+ extend ::Google::Protobuf::MessageExts::ClassMethods
683
+ end
684
+
685
+ # An identifier associated with a user.
686
+ # @!attribute [rw] email
687
+ # @return [::String]
688
+ # Optional. An email address.
689
+ # @!attribute [rw] phone_number
690
+ # @return [::String]
691
+ # Optional. A phone number. Should use the E.164 format.
692
+ # @!attribute [rw] username
693
+ # @return [::String]
694
+ # Optional. A unique username, if different from all the other identifiers
695
+ # and `account_id` that are provided. Can be a unique login handle or
696
+ # display name for a user.
697
+ class UserId
698
+ include ::Google::Protobuf::MessageExts
699
+ extend ::Google::Protobuf::MessageExts::ClassMethods
700
+ end
701
+
613
702
  # Risk analysis result for an event.
614
- # @!attribute [rw] score
703
+ # @!attribute [r] score
615
704
  # @return [::Float]
616
- # Legitimate event score from 0.0 to 1.0.
705
+ # Output only. Legitimate event score from 0.0 to 1.0.
617
706
  # (1.0 means very likely legitimate traffic while 0.0 means very likely
618
707
  # non-legitimate traffic).
619
- # @!attribute [rw] reasons
708
+ # @!attribute [r] reasons
620
709
  # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::RiskAnalysis::ClassificationReason>]
621
- # Reasons contributing to the risk analysis verdict.
710
+ # Output only. Reasons contributing to the risk analysis verdict.
711
+ # @!attribute [r] extended_verdict_reasons
712
+ # @return [::Array<::String>]
713
+ # Output only. Extended verdict reasons to be used for experimentation only.
714
+ # The set of possible reasons is subject to change.
622
715
  class RiskAnalysis
623
716
  include ::Google::Protobuf::MessageExts
624
717
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -654,33 +747,34 @@ module Google
654
747
  end
655
748
 
656
749
  # Properties of the provided event token.
657
- # @!attribute [rw] valid
750
+ # @!attribute [r] valid
658
751
  # @return [::Boolean]
659
- # Whether the provided user response token is valid. When valid = false, the
660
- # reason could be specified in invalid_reason or it could also be due to
661
- # a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey
662
- # used to generate the token was different than the one specified in the
663
- # assessment).
664
- # @!attribute [rw] invalid_reason
752
+ # Output only. Whether the provided user response token is valid. When valid
753
+ # = false, the reason could be specified in invalid_reason or it could also
754
+ # be due to a user failing to solve a challenge or a sitekey mismatch (i.e
755
+ # the sitekey used to generate the token was different than the one specified
756
+ # in the assessment).
757
+ # @!attribute [r] invalid_reason
665
758
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::TokenProperties::InvalidReason]
666
- # Reason associated with the response when valid = false.
667
- # @!attribute [rw] create_time
759
+ # Output only. Reason associated with the response when valid = false.
760
+ # @!attribute [r] create_time
668
761
  # @return [::Google::Protobuf::Timestamp]
669
- # The timestamp corresponding to the generation of the token.
670
- # @!attribute [rw] hostname
671
- # @return [::String]
672
- # The hostname of the page on which the token was generated (Web keys only).
673
- # @!attribute [rw] android_package_name
762
+ # Output only. The timestamp corresponding to the generation of the token.
763
+ # @!attribute [r] hostname
674
764
  # @return [::String]
675
- # The name of the Android package with which the token was generated (Android
765
+ # Output only. The hostname of the page on which the token was generated (Web
676
766
  # keys only).
677
- # @!attribute [rw] ios_bundle_id
767
+ # @!attribute [r] android_package_name
678
768
  # @return [::String]
679
- # The ID of the iOS bundle with which the token was generated (iOS keys
680
- # only).
681
- # @!attribute [rw] action
769
+ # Output only. The name of the Android package with which the token was
770
+ # generated (Android keys only).
771
+ # @!attribute [r] ios_bundle_id
682
772
  # @return [::String]
683
- # Action name provided at token generation.
773
+ # Output only. The ID of the iOS bundle with which the token was generated
774
+ # (iOS keys only).
775
+ # @!attribute [r] action
776
+ # @return [::String]
777
+ # Output only. Action name provided at token generation.
684
778
  class TokenProperties
685
779
  include ::Google::Protobuf::MessageExts
686
780
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -712,27 +806,32 @@ module Google
712
806
  end
713
807
 
714
808
  # Assessment for Fraud Prevention.
715
- # @!attribute [rw] transaction_risk
809
+ # @!attribute [r] transaction_risk
716
810
  # @return [::Float]
717
- # Probability (0-1) of this transaction being fraudulent. Summarizes the
718
- # combined risk of attack vectors below.
719
- # @!attribute [rw] stolen_instrument_verdict
811
+ # Output only. Probability of this transaction being fraudulent. Summarizes
812
+ # the combined risk of attack vectors below. Values are from 0.0 (lowest)
813
+ # to 1.0 (highest).
814
+ # @!attribute [r] stolen_instrument_verdict
720
815
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::FraudPreventionAssessment::StolenInstrumentVerdict]
721
- # Assessment of this transaction for risk of a stolen instrument.
722
- # @!attribute [rw] card_testing_verdict
816
+ # Output only. Assessment of this transaction for risk of a stolen
817
+ # instrument.
818
+ # @!attribute [r] card_testing_verdict
723
819
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::FraudPreventionAssessment::CardTestingVerdict]
724
- # Assessment of this transaction for risk of being part of a card testing
725
- # attack.
820
+ # Output only. Assessment of this transaction for risk of being part of a
821
+ # card testing attack.
822
+ # @!attribute [r] behavioral_trust_verdict
823
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FraudPreventionAssessment::BehavioralTrustVerdict]
824
+ # Output only. Assessment of this transaction for behavioral trust.
726
825
  class FraudPreventionAssessment
727
826
  include ::Google::Protobuf::MessageExts
728
827
  extend ::Google::Protobuf::MessageExts::ClassMethods
729
828
 
730
829
  # Information about stolen instrument fraud, where the user is not the
731
830
  # legitimate owner of the instrument being used for the purchase.
732
- # @!attribute [rw] risk
831
+ # @!attribute [r] risk
733
832
  # @return [::Float]
734
- # Probability (0-1) of this transaction being executed with a stolen
735
- # instrument.
833
+ # Output only. Probability of this transaction being executed with a stolen
834
+ # instrument. Values are from 0.0 (lowest) to 1.0 (highest).
736
835
  class StolenInstrumentVerdict
737
836
  include ::Google::Protobuf::MessageExts
738
837
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -740,20 +839,86 @@ module Google
740
839
 
741
840
  # Information about card testing fraud, where an adversary is testing
742
841
  # fraudulently obtained cards or brute forcing their details.
743
- # @!attribute [rw] risk
842
+ # @!attribute [r] risk
744
843
  # @return [::Float]
745
- # Probability (0-1) of this transaction attempt being part of a card
746
- # testing attack.
844
+ # Output only. Probability of this transaction attempt being part of a card
845
+ # testing attack. Values are from 0.0 (lowest) to 1.0 (highest).
747
846
  class CardTestingVerdict
748
847
  include ::Google::Protobuf::MessageExts
749
848
  extend ::Google::Protobuf::MessageExts::ClassMethods
750
849
  end
850
+
851
+ # Information about behavioral trust of the transaction.
852
+ # @!attribute [r] trust
853
+ # @return [::Float]
854
+ # Output only. Probability of this transaction attempt being executed in a
855
+ # behaviorally trustworthy way. Values are from 0.0 (lowest) to 1.0
856
+ # (highest).
857
+ class BehavioralTrustVerdict
858
+ include ::Google::Protobuf::MessageExts
859
+ extend ::Google::Protobuf::MessageExts::ClassMethods
860
+ end
861
+ end
862
+
863
+ # Fraud signals describing users and cards involved in the transaction.
864
+ # @!attribute [r] user_signals
865
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FraudSignals::UserSignals]
866
+ # Output only. Signals describing the end user in this transaction.
867
+ # @!attribute [r] card_signals
868
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FraudSignals::CardSignals]
869
+ # Output only. Signals describing the payment card or cards used in this
870
+ # transaction.
871
+ class FraudSignals
872
+ include ::Google::Protobuf::MessageExts
873
+ extend ::Google::Protobuf::MessageExts::ClassMethods
874
+
875
+ # Signals describing the user involved in this transaction.
876
+ # @!attribute [r] active_days_lower_bound
877
+ # @return [::Integer]
878
+ # Output only. This user (based on email, phone, and other identifiers) has
879
+ # been seen on the internet for at least this number of days.
880
+ # @!attribute [r] synthetic_risk
881
+ # @return [::Float]
882
+ # Output only. Likelihood (from 0.0 to 1.0) this user includes synthetic
883
+ # components in their identity, such as a randomly generated email address,
884
+ # temporary phone number, or fake shipping address.
885
+ class UserSignals
886
+ include ::Google::Protobuf::MessageExts
887
+ extend ::Google::Protobuf::MessageExts::ClassMethods
888
+ end
889
+
890
+ # Signals describing the payment card used in this transaction.
891
+ # @!attribute [r] card_labels
892
+ # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::FraudSignals::CardSignals::CardLabel>]
893
+ # Output only. The labels for the payment card in this transaction.
894
+ class CardSignals
895
+ include ::Google::Protobuf::MessageExts
896
+ extend ::Google::Protobuf::MessageExts::ClassMethods
897
+
898
+ # Risk labels describing the card being assessed, such as its funding
899
+ # mechanism.
900
+ module CardLabel
901
+ # No label specified.
902
+ CARD_LABEL_UNSPECIFIED = 0
903
+
904
+ # This card has been detected as prepaid.
905
+ PREPAID = 1
906
+
907
+ # This card has been detected as virtual, such as a card number generated
908
+ # for a single transaction or merchant.
909
+ VIRTUAL = 2
910
+
911
+ # This card has been detected as being used in an unexpected geographic
912
+ # location.
913
+ UNEXPECTED_LOCATION = 3
914
+ end
915
+ end
751
916
  end
752
917
 
753
918
  # Account defender risk assessment.
754
- # @!attribute [rw] labels
919
+ # @!attribute [r] labels
755
920
  # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AccountDefenderAssessment::AccountDefenderLabel>]
756
- # Labels for this request.
921
+ # Output only. Labels for this request.
757
922
  class AccountDefenderAssessment
758
923
  include ::Google::Protobuf::MessageExts
759
924
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -785,7 +950,7 @@ module Google
785
950
  # @!attribute [rw] parent
786
951
  # @return [::String]
787
952
  # Required. The name of the project in which the key will be created, in the
788
- # format "projects/\\{project}".
953
+ # format `projects/{project}`.
789
954
  # @!attribute [rw] key
790
955
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::Key]
791
956
  # Required. Information to create a reCAPTCHA Enterprise key.
@@ -798,7 +963,7 @@ module Google
798
963
  # @!attribute [rw] parent
799
964
  # @return [::String]
800
965
  # Required. The name of the project that contains the keys that will be
801
- # listed, in the format "projects/\\{project}".
966
+ # listed, in the format `projects/{project}`.
802
967
  # @!attribute [rw] page_size
803
968
  # @return [::Integer]
804
969
  # Optional. The maximum number of keys to return. Default is 10. Max limit is
@@ -829,7 +994,7 @@ module Google
829
994
  # @!attribute [rw] key
830
995
  # @return [::String]
831
996
  # Required. The public key name linked to the requested secret key in the
832
- # format "projects/\\{project}/keys/\\{key}".
997
+ # format `projects/{project}/keys/{key}`.
833
998
  class RetrieveLegacySecretKeyRequest
834
999
  include ::Google::Protobuf::MessageExts
835
1000
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -839,7 +1004,7 @@ module Google
839
1004
  # @!attribute [rw] name
840
1005
  # @return [::String]
841
1006
  # Required. The name of the requested key, in the format
842
- # "projects/\\{project}/keys/\\{key}".
1007
+ # `projects/{project}/keys/{key}`.
843
1008
  class GetKeyRequest
844
1009
  include ::Google::Protobuf::MessageExts
845
1010
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -862,17 +1027,94 @@ module Google
862
1027
  # @!attribute [rw] name
863
1028
  # @return [::String]
864
1029
  # Required. The name of the key to be deleted, in the format
865
- # "projects/\\{project}/keys/\\{key}".
1030
+ # `projects/{project}/keys/{key}`.
866
1031
  class DeleteKeyRequest
867
1032
  include ::Google::Protobuf::MessageExts
868
1033
  extend ::Google::Protobuf::MessageExts::ClassMethods
869
1034
  end
870
1035
 
1036
+ # The create firewall policy request message.
1037
+ # @!attribute [rw] parent
1038
+ # @return [::String]
1039
+ # Required. The name of the project this policy will apply to, in the format
1040
+ # `projects/{project}`.
1041
+ # @!attribute [rw] firewall_policy
1042
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy]
1043
+ # Required. Information to create the policy.
1044
+ class CreateFirewallPolicyRequest
1045
+ include ::Google::Protobuf::MessageExts
1046
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1047
+ end
1048
+
1049
+ # The list firewall policies request message.
1050
+ # @!attribute [rw] parent
1051
+ # @return [::String]
1052
+ # Required. The name of the project to list the policies for, in the format
1053
+ # `projects/{project}`.
1054
+ # @!attribute [rw] page_size
1055
+ # @return [::Integer]
1056
+ # Optional. The maximum number of policies to return. Default is 10. Max
1057
+ # limit is 1000.
1058
+ # @!attribute [rw] page_token
1059
+ # @return [::String]
1060
+ # Optional. The next_page_token value returned from a previous.
1061
+ # ListFirewallPoliciesRequest, if any.
1062
+ class ListFirewallPoliciesRequest
1063
+ include ::Google::Protobuf::MessageExts
1064
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1065
+ end
1066
+
1067
+ # Response to request to list firewall policies belonging to a key.
1068
+ # @!attribute [rw] firewall_policies
1069
+ # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy>]
1070
+ # Policy details.
1071
+ # @!attribute [rw] next_page_token
1072
+ # @return [::String]
1073
+ # Token to retrieve the next page of results. It is set to empty if no
1074
+ # policies remain in results.
1075
+ class ListFirewallPoliciesResponse
1076
+ include ::Google::Protobuf::MessageExts
1077
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1078
+ end
1079
+
1080
+ # The get firewall policy request message.
1081
+ # @!attribute [rw] name
1082
+ # @return [::String]
1083
+ # Required. The name of the requested policy, in the format
1084
+ # `projects/{project}/firewallpolicies/{firewallpolicy}`.
1085
+ class GetFirewallPolicyRequest
1086
+ include ::Google::Protobuf::MessageExts
1087
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1088
+ end
1089
+
1090
+ # The update firewall policy request message.
1091
+ # @!attribute [rw] firewall_policy
1092
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy]
1093
+ # Required. The policy to update.
1094
+ # @!attribute [rw] update_mask
1095
+ # @return [::Google::Protobuf::FieldMask]
1096
+ # Optional. The mask to control which fields of the policy get updated. If
1097
+ # the mask is not present, all fields will be updated.
1098
+ class UpdateFirewallPolicyRequest
1099
+ include ::Google::Protobuf::MessageExts
1100
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1101
+ end
1102
+
1103
+ # The delete firewall policy request message.
1104
+ # @!attribute [rw] name
1105
+ # @return [::String]
1106
+ # Required. The name of the policy to be deleted, in the format
1107
+ # `projects/{project}/firewallpolicies/{firewallpolicy}`.
1108
+ class DeleteFirewallPolicyRequest
1109
+ include ::Google::Protobuf::MessageExts
1110
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1111
+ end
1112
+
871
1113
  # The migrate key request message.
872
1114
  # @!attribute [rw] name
873
1115
  # @return [::String]
874
1116
  # Required. The name of the key to be migrated, in the format
875
- # "projects/\\{project}/keys/\\{key}".
1117
+ # `projects/{project}/keys/{key}`.
876
1118
  # @!attribute [rw] skip_billing_check
877
1119
  # @return [::Boolean]
878
1120
  # Optional. If true, skips the billing check.
@@ -892,7 +1134,7 @@ module Google
892
1134
  # @!attribute [rw] name
893
1135
  # @return [::String]
894
1136
  # Required. The name of the requested metrics, in the format
895
- # "projects/\\{project}/keys/\\{key}/metrics".
1137
+ # `projects/{project}/keys/{key}/metrics`.
896
1138
  class GetMetricsRequest
897
1139
  include ::Google::Protobuf::MessageExts
898
1140
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -901,8 +1143,8 @@ module Google
901
1143
  # Metrics for a single Key.
902
1144
  # @!attribute [r] name
903
1145
  # @return [::String]
904
- # Output only. The name of the metrics, in the format
905
- # "projects/\\{project}/keys/\\{key}/metrics".
1146
+ # Output only. Identifier. The name of the metrics, in the format
1147
+ # `projects/{project}/keys/{key}/metrics`.
906
1148
  # @!attribute [rw] start_time
907
1149
  # @return [::Google::Protobuf::Timestamp]
908
1150
  # Inclusive start time aligned to a day (UTC).
@@ -937,11 +1179,11 @@ module Google
937
1179
  # use reCAPTCHA Enterprise.
938
1180
  # @!attribute [rw] name
939
1181
  # @return [::String]
940
- # The resource name for the Key in the format
941
- # "projects/\\{project}/keys/\\{key}".
1182
+ # Identifier. The resource name for the Key in the format
1183
+ # `projects/{project}/keys/{key}`.
942
1184
  # @!attribute [rw] display_name
943
1185
  # @return [::String]
944
- # Human-readable display name of this key. Modifiable by user.
1186
+ # Required. Human-readable display name of this key. Modifiable by user.
945
1187
  # @!attribute [rw] web_settings
946
1188
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings]
947
1189
  # Settings for keys that can be used by websites.
@@ -953,17 +1195,17 @@ module Google
953
1195
  # Settings for keys that can be used by iOS apps.
954
1196
  # @!attribute [rw] labels
955
1197
  # @return [::Google::Protobuf::Map{::String => ::String}]
956
- # See <a href="https://cloud.google.com/recaptcha-enterprise/docs/labels">
957
- # Creating and managing labels</a>.
1198
+ # Optional. See [Creating and managing labels]
1199
+ # (https://cloud.google.com/recaptcha-enterprise/docs/labels).
958
1200
  # @!attribute [r] create_time
959
1201
  # @return [::Google::Protobuf::Timestamp]
960
- # Output only. The timestamp corresponding to the creation of this Key.
1202
+ # Output only. The timestamp corresponding to the creation of this key.
961
1203
  # @!attribute [rw] testing_options
962
1204
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions]
963
- # Options for user acceptance testing.
1205
+ # Optional. Options for user acceptance testing.
964
1206
  # @!attribute [rw] waf_settings
965
1207
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::WafSettings]
966
- # Settings for WAF
1208
+ # Optional. Settings for WAF
967
1209
  class Key
968
1210
  include ::Google::Protobuf::MessageExts
969
1211
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -981,13 +1223,13 @@ module Google
981
1223
  # Options for user acceptance testing.
982
1224
  # @!attribute [rw] testing_score
983
1225
  # @return [::Float]
984
- # All assessments for this Key will return this score. Must be between 0
985
- # (likely not legitimate) and 1 (likely legitimate) inclusive.
1226
+ # Optional. All assessments for this Key will return this score. Must be
1227
+ # between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
986
1228
  # @!attribute [rw] testing_challenge
987
1229
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions::TestingChallenge]
988
- # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests
989
- # for this site will return nocaptcha if NOCAPTCHA, or an unsolvable
990
- # challenge if CHALLENGE.
1230
+ # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all
1231
+ # challenge requests for this site will return nocaptcha if NOCAPTCHA, or an
1232
+ # unsolvable challenge if CHALLENGE.
991
1233
  class TestingOptions
992
1234
  include ::Google::Protobuf::MessageExts
993
1235
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1012,25 +1254,25 @@ module Google
1012
1254
  # Settings specific to keys that can be used by websites.
1013
1255
  # @!attribute [rw] allow_all_domains
1014
1256
  # @return [::Boolean]
1015
- # If set to true, it means allowed_domains will not be enforced.
1257
+ # Optional. If set to true, it means allowed_domains will not be enforced.
1016
1258
  # @!attribute [rw] allowed_domains
1017
1259
  # @return [::Array<::String>]
1018
- # Domains or subdomains of websites allowed to use the key. All subdomains
1019
- # of an allowed domain are automatically allowed. A valid domain requires a
1020
- # host and must not include any path, port, query or fragment.
1260
+ # Optional. Domains or subdomains of websites allowed to use the key. All
1261
+ # subdomains of an allowed domain are automatically allowed. A valid domain
1262
+ # requires a host and must not include any path, port, query or fragment.
1021
1263
  # Examples: 'example.com' or 'subdomain.example.com'
1022
1264
  # @!attribute [rw] allow_amp_traffic
1023
1265
  # @return [::Boolean]
1024
- # If set to true, the key can be used on AMP (Accelerated Mobile Pages)
1025
- # websites. This is supported only for the SCORE integration type.
1266
+ # Optional. If set to true, the key can be used on AMP (Accelerated Mobile
1267
+ # Pages) websites. This is supported only for the SCORE integration type.
1026
1268
  # @!attribute [rw] integration_type
1027
1269
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::IntegrationType]
1028
1270
  # Required. Describes how this key is integrated with the website.
1029
1271
  # @!attribute [rw] challenge_security_preference
1030
1272
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::ChallengeSecurityPreference]
1031
- # Settings for the frequency and difficulty at which this key triggers
1032
- # captcha challenges. This should only be specified for IntegrationTypes
1033
- # CHECKBOX and INVISIBLE.
1273
+ # Optional. Settings for the frequency and difficulty at which this key
1274
+ # triggers captcha challenges. This should only be specified for
1275
+ # IntegrationTypes CHECKBOX and INVISIBLE.
1034
1276
  class WebKeySettings
1035
1277
  include ::Google::Protobuf::MessageExts
1036
1278
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1075,11 +1317,16 @@ module Google
1075
1317
  # Settings specific to keys that can be used by Android apps.
1076
1318
  # @!attribute [rw] allow_all_package_names
1077
1319
  # @return [::Boolean]
1078
- # If set to true, allowed_package_names are not enforced.
1320
+ # Optional. If set to true, allowed_package_names are not enforced.
1079
1321
  # @!attribute [rw] allowed_package_names
1080
1322
  # @return [::Array<::String>]
1081
- # Android package names of apps allowed to use the key.
1323
+ # Optional. Android package names of apps allowed to use the key.
1082
1324
  # Example: 'com.companyname.appname'
1325
+ # @!attribute [rw] support_non_google_app_store_distribution
1326
+ # @return [::Boolean]
1327
+ # Optional. Set to true for keys that are used in an Android application that
1328
+ # is available for download in app stores in addition to the Google Play
1329
+ # Store.
1083
1330
  class AndroidKeySettings
1084
1331
  include ::Google::Protobuf::MessageExts
1085
1332
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1088,16 +1335,41 @@ module Google
1088
1335
  # Settings specific to keys that can be used by iOS apps.
1089
1336
  # @!attribute [rw] allow_all_bundle_ids
1090
1337
  # @return [::Boolean]
1091
- # If set to true, allowed_bundle_ids are not enforced.
1338
+ # Optional. If set to true, allowed_bundle_ids are not enforced.
1092
1339
  # @!attribute [rw] allowed_bundle_ids
1093
1340
  # @return [::Array<::String>]
1094
- # iOS bundle ids of apps allowed to use the key.
1341
+ # Optional. iOS bundle ids of apps allowed to use the key.
1095
1342
  # Example: 'com.companyname.productname.appname'
1343
+ # @!attribute [rw] apple_developer_id
1344
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::AppleDeveloperId]
1345
+ # Optional. Apple Developer account details for the app that is protected by
1346
+ # the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks
1347
+ # like Apple App Attest and Apple DeviceCheck to protect your app from abuse.
1348
+ # Providing these fields allows reCAPTCHA Enterprise to get a better
1349
+ # assessment of the integrity of your app.
1096
1350
  class IOSKeySettings
1097
1351
  include ::Google::Protobuf::MessageExts
1098
1352
  extend ::Google::Protobuf::MessageExts::ClassMethods
1099
1353
  end
1100
1354
 
1355
+ # Contains fields that are required to perform Apple-specific integrity checks.
1356
+ # @!attribute [rw] private_key
1357
+ # @return [::String]
1358
+ # Required. Input only. A private key (downloaded as a text file with a .p8
1359
+ # file extension) generated for your Apple Developer account. Ensure that
1360
+ # Apple DeviceCheck is enabled for the private key.
1361
+ # @!attribute [rw] key_id
1362
+ # @return [::String]
1363
+ # Required. The Apple developer key ID (10-character string).
1364
+ # @!attribute [rw] team_id
1365
+ # @return [::String]
1366
+ # Required. The Apple team ID (10-character string) owning the provisioning
1367
+ # profile used to build your application.
1368
+ class AppleDeveloperId
1369
+ include ::Google::Protobuf::MessageExts
1370
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1371
+ end
1372
+
1101
1373
  # Score distribution.
1102
1374
  # @!attribute [rw] score_buckets
1103
1375
  # @return [::Google::Protobuf::Map{::Integer => ::Integer}]
@@ -1162,6 +1434,134 @@ module Google
1162
1434
  extend ::Google::Protobuf::MessageExts::ClassMethods
1163
1435
  end
1164
1436
 
1437
+ # Policy config assessment.
1438
+ # @!attribute [r] error
1439
+ # @return [::Google::Rpc::Status]
1440
+ # Output only. If the processing of a policy config fails, an error will be
1441
+ # populated and the firewall_policy will be left empty.
1442
+ # @!attribute [r] firewall_policy
1443
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy]
1444
+ # Output only. The policy that matched the request. If more than one policy
1445
+ # may match, this is the first match. If no policy matches the incoming
1446
+ # request, the policy field will be left empty.
1447
+ class FirewallPolicyAssessment
1448
+ include ::Google::Protobuf::MessageExts
1449
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1450
+ end
1451
+
1452
+ # An individual action. Each action represents what to do if a policy
1453
+ # matches.
1454
+ # @!attribute [rw] allow
1455
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::AllowAction]
1456
+ # The user request did not match any policy and should be allowed
1457
+ # access to the requested resource.
1458
+ # @!attribute [rw] block
1459
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::BlockAction]
1460
+ # This action will deny access to a given page. The user will get an HTTP
1461
+ # error code.
1462
+ # @!attribute [rw] redirect
1463
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::RedirectAction]
1464
+ # This action will redirect the request to a ReCaptcha interstitial to
1465
+ # attach a token.
1466
+ # @!attribute [rw] substitute
1467
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SubstituteAction]
1468
+ # This action will transparently serve a different page to an offending
1469
+ # user.
1470
+ # @!attribute [rw] set_header
1471
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SetHeaderAction]
1472
+ # This action will set a custom header but allow the request to continue
1473
+ # to the customer backend.
1474
+ class FirewallAction
1475
+ include ::Google::Protobuf::MessageExts
1476
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1477
+
1478
+ # An allow action continues processing a request unimpeded.
1479
+ class AllowAction
1480
+ include ::Google::Protobuf::MessageExts
1481
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1482
+ end
1483
+
1484
+ # A block action serves an HTTP error code a prevents the request from
1485
+ # hitting the backend.
1486
+ class BlockAction
1487
+ include ::Google::Protobuf::MessageExts
1488
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1489
+ end
1490
+
1491
+ # A redirect action returns a 307 (temporary redirect) response, pointing
1492
+ # the user to a ReCaptcha interstitial page to attach a token.
1493
+ class RedirectAction
1494
+ include ::Google::Protobuf::MessageExts
1495
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1496
+ end
1497
+
1498
+ # A substitute action transparently serves a different page than the one
1499
+ # requested.
1500
+ # @!attribute [rw] path
1501
+ # @return [::String]
1502
+ # Optional. The address to redirect to. The target is a relative path in
1503
+ # the current host. Example: "/blog/404.html".
1504
+ class SubstituteAction
1505
+ include ::Google::Protobuf::MessageExts
1506
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1507
+ end
1508
+
1509
+ # A set header action sets a header and forwards the request to the
1510
+ # backend. This can be used to trigger custom protection implemented on the
1511
+ # backend.
1512
+ # @!attribute [rw] key
1513
+ # @return [::String]
1514
+ # Optional. The header key to set in the request to the backend server.
1515
+ # @!attribute [rw] value
1516
+ # @return [::String]
1517
+ # Optional. The header value to set in the request to the backend server.
1518
+ class SetHeaderAction
1519
+ include ::Google::Protobuf::MessageExts
1520
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1521
+ end
1522
+ end
1523
+
1524
+ # A FirewallPolicy represents a single matching pattern and resulting actions
1525
+ # to take.
1526
+ # @!attribute [rw] name
1527
+ # @return [::String]
1528
+ # Identifier. The resource name for the FirewallPolicy in the format
1529
+ # `projects/{project}/firewallpolicies/{firewallpolicy}`.
1530
+ # @!attribute [rw] description
1531
+ # @return [::String]
1532
+ # Optional. A description of what this policy aims to achieve, for
1533
+ # convenience purposes. The description can at most include 256 UTF-8
1534
+ # characters.
1535
+ # @!attribute [rw] path
1536
+ # @return [::String]
1537
+ # Optional. The path for which this policy applies, specified as a glob
1538
+ # pattern. For more information on glob, see the [manual
1539
+ # page](https://man7.org/linux/man-pages/man7/glob.7.html).
1540
+ # A path has a max length of 200 characters.
1541
+ # @!attribute [rw] condition
1542
+ # @return [::String]
1543
+ # Optional. A CEL (Common Expression Language) conditional expression that
1544
+ # specifies if this policy applies to an incoming user request. If this
1545
+ # condition evaluates to true and the requested path matched the path
1546
+ # pattern, the associated actions should be executed by the caller. The
1547
+ # condition string is checked for CEL syntax correctness on creation. For
1548
+ # more information, see the [CEL spec](https://github.com/google/cel-spec)
1549
+ # and its [language
1550
+ # definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md).
1551
+ # A condition has a max length of 500 characters.
1552
+ # @!attribute [rw] actions
1553
+ # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction>]
1554
+ # Optional. The actions that the caller should take regarding user access.
1555
+ # There should be at most one terminal action. A terminal action is any
1556
+ # action that forces a response, such as `AllowAction`,
1557
+ # `BlockAction` or `SubstituteAction`.
1558
+ # Zero or more non-terminal actions such as `SetHeader` might be
1559
+ # specified. A single policy can contain up to 16 actions.
1560
+ class FirewallPolicy
1561
+ include ::Google::Protobuf::MessageExts
1562
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1563
+ end
1564
+
1165
1565
  # The request message to list memberships in a related account group.
1166
1566
  # @!attribute [rw] parent
1167
1567
  # @return [::String]
@@ -1202,7 +1602,7 @@ module Google
1202
1602
  # @!attribute [rw] parent
1203
1603
  # @return [::String]
1204
1604
  # Required. The name of the project to list related account groups from, in
1205
- # the format "projects/\\{project}".
1605
+ # the format `projects/{project}`.
1206
1606
  # @!attribute [rw] page_size
1207
1607
  # @return [::Integer]
1208
1608
  # Optional. The maximum number of groups to return. The service might return
@@ -1239,12 +1639,21 @@ module Google
1239
1639
  # @return [::String]
1240
1640
  # Required. The name of the project to search related account group
1241
1641
  # memberships from. Specify the project name in the following format:
1242
- # "projects/\\{project}".
1642
+ # `projects/{project}`.
1643
+ # @!attribute [rw] account_id
1644
+ # @return [::String]
1645
+ # Optional. The unique stable account identifier used to search connections.
1646
+ # The identifier should correspond to an `account_id` provided in a previous
1647
+ # `CreateAssessment` or `AnnotateAssessment` call. Either hashed_account_id
1648
+ # or account_id must be set, but not both.
1243
1649
  # @!attribute [rw] hashed_account_id
1650
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1244
1651
  # @return [::String]
1245
- # Optional. The unique stable hashed user identifier we should search
1246
- # connections to. The identifier should correspond to a `hashed_account_id`
1247
- # provided in a previous `CreateAssessment` or `AnnotateAssessment` call.
1652
+ # Optional. Deprecated: use `account_id` instead.
1653
+ # The unique stable hashed account identifier used to search connections. The
1654
+ # identifier should correspond to a `hashed_account_id` provided in a
1655
+ # previous `CreateAssessment` or `AnnotateAssessment` call. Either
1656
+ # hashed_account_id or account_id must be set, but not both.
1248
1657
  # @!attribute [rw] page_size
1249
1658
  # @return [::Integer]
1250
1659
  # Optional. The maximum number of groups to return. The service might return
@@ -1280,11 +1689,18 @@ module Google
1280
1689
  # A membership in a group of related accounts.
1281
1690
  # @!attribute [rw] name
1282
1691
  # @return [::String]
1283
- # Required. The resource name for this membership in the format
1692
+ # Required. Identifier. The resource name for this membership in the format
1284
1693
  # `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`.
1694
+ # @!attribute [rw] account_id
1695
+ # @return [::String]
1696
+ # The unique stable account identifier of the member. The identifier
1697
+ # corresponds to an `account_id` provided in a previous `CreateAssessment` or
1698
+ # `AnnotateAssessment` call.
1285
1699
  # @!attribute [rw] hashed_account_id
1700
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1286
1701
  # @return [::String]
1287
- # The unique stable hashed user identifier of the member. The identifier
1702
+ # Deprecated: use `account_id` instead.
1703
+ # The unique stable hashed account identifier of the member. The identifier
1288
1704
  # corresponds to a `hashed_account_id` provided in a previous
1289
1705
  # `CreateAssessment` or `AnnotateAssessment` call.
1290
1706
  class RelatedAccountGroupMembership
@@ -1295,7 +1711,8 @@ module Google
1295
1711
  # A group of related accounts.
1296
1712
  # @!attribute [rw] name
1297
1713
  # @return [::String]
1298
- # Required. The resource name for the related account group in the format
1714
+ # Required. Identifier. The resource name for the related account group in
1715
+ # the format
1299
1716
  # `projects/{project}/relatedaccountgroups/{related_account_group}`.
1300
1717
  class RelatedAccountGroup
1301
1718
  include ::Google::Protobuf::MessageExts
@@ -1329,6 +1746,10 @@ module Google
1329
1746
 
1330
1747
  # Use reCAPTCHA action-tokens to protect user actions.
1331
1748
  ACTION_TOKEN = 3
1749
+
1750
+ # Use reCAPTCHA WAF express protection to protect any content other than
1751
+ # web pages, like APIs and IoT devices.
1752
+ EXPRESS = 5
1332
1753
  end
1333
1754
 
1334
1755
  # Web Application Firewalls supported by reCAPTCHA Enterprise.
@@ -1338,6 +1759,9 @@ module Google
1338
1759
 
1339
1760
  # Cloud Armor
1340
1761
  CA = 1
1762
+
1763
+ # Fastly
1764
+ FASTLY = 3
1341
1765
  end
1342
1766
  end
1343
1767
  end