/
recaptchaenterprise.proto
1957 lines (1614 loc) · 75.4 KB
/
recaptchaenterprise.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.recaptchaenterprise.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/field_info.proto";
import "google/api/resource.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.RecaptchaEnterprise.V1";
option go_package = "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb;recaptchaenterprisepb";
option java_multiple_files = true;
option java_outer_classname = "RecaptchaEnterpriseProto";
option java_package = "com.google.recaptchaenterprise.v1";
option objc_class_prefix = "GCRE";
option php_namespace = "Google\\Cloud\\RecaptchaEnterprise\\V1";
option ruby_package = "Google::Cloud::RecaptchaEnterprise::V1";
// Service to determine the likelihood an event is legitimate.
service RecaptchaEnterpriseService {
option (google.api.default_host) = "recaptchaenterprise.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
// Creates an Assessment of the likelihood an event is legitimate.
rpc CreateAssessment(CreateAssessmentRequest) returns (Assessment) {
option (google.api.http) = {
post: "/v1/{parent=projects/*}/assessments"
body: "assessment"
};
option (google.api.method_signature) = "parent,assessment";
}
// Annotates a previously created Assessment to provide additional information
// on whether the event turned out to be authentic or fraudulent.
rpc AnnotateAssessment(AnnotateAssessmentRequest)
returns (AnnotateAssessmentResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/assessments/*}:annotate"
body: "*"
};
option (google.api.method_signature) = "name,annotation";
}
// Creates a new reCAPTCHA Enterprise key.
rpc CreateKey(CreateKeyRequest) returns (Key) {
option (google.api.http) = {
post: "/v1/{parent=projects/*}/keys"
body: "key"
};
option (google.api.method_signature) = "parent,key";
}
// Returns the list of all keys that belong to a project.
rpc ListKeys(ListKeysRequest) returns (ListKeysResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*}/keys"
};
option (google.api.method_signature) = "parent";
}
// Returns the secret key related to the specified public key.
// You must use the legacy secret key only in a 3rd party integration with
// legacy reCAPTCHA.
rpc RetrieveLegacySecretKey(RetrieveLegacySecretKeyRequest)
returns (RetrieveLegacySecretKeyResponse) {
option (google.api.http) = {
get: "/v1/{key=projects/*/keys/*}:retrieveLegacySecretKey"
};
option (google.api.method_signature) = "key";
}
// Returns the specified key.
rpc GetKey(GetKeyRequest) returns (Key) {
option (google.api.http) = {
get: "/v1/{name=projects/*/keys/*}"
};
option (google.api.method_signature) = "name";
}
// Updates the specified key.
rpc UpdateKey(UpdateKeyRequest) returns (Key) {
option (google.api.http) = {
patch: "/v1/{key.name=projects/*/keys/*}"
body: "key"
};
option (google.api.method_signature) = "key,update_mask";
}
// Deletes the specified key.
rpc DeleteKey(DeleteKeyRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/keys/*}"
};
option (google.api.method_signature) = "name";
}
// Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise.
// Once a key is migrated, it can be used from either product. SiteVerify
// requests are billed as CreateAssessment calls. You must be
// authenticated as one of the current owners of the reCAPTCHA Key, and
// your user must have the reCAPTCHA Enterprise Admin IAM role in the
// destination project.
rpc MigrateKey(MigrateKeyRequest) returns (Key) {
option (google.api.http) = {
post: "/v1/{name=projects/*/keys/*}:migrate"
body: "*"
};
}
// Get some aggregated metrics for a Key. This data can be used to build
// dashboards.
rpc GetMetrics(GetMetricsRequest) returns (Metrics) {
option (google.api.http) = {
get: "/v1/{name=projects/*/keys/*/metrics}"
};
option (google.api.method_signature) = "name";
}
// Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA
// Enterprise actions can be executed.
// A project may have a maximum of 1000 policies.
rpc CreateFirewallPolicy(CreateFirewallPolicyRequest)
returns (FirewallPolicy) {
option (google.api.http) = {
post: "/v1/{parent=projects/*}/firewallpolicies"
body: "firewall_policy"
};
option (google.api.method_signature) = "parent,firewall_policy";
}
// Returns the list of all firewall policies that belong to a project.
rpc ListFirewallPolicies(ListFirewallPoliciesRequest)
returns (ListFirewallPoliciesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*}/firewallpolicies"
};
option (google.api.method_signature) = "parent";
}
// Returns the specified firewall policy.
rpc GetFirewallPolicy(GetFirewallPolicyRequest) returns (FirewallPolicy) {
option (google.api.http) = {
get: "/v1/{name=projects/*/firewallpolicies/*}"
};
option (google.api.method_signature) = "name";
}
// Updates the specified firewall policy.
rpc UpdateFirewallPolicy(UpdateFirewallPolicyRequest)
returns (FirewallPolicy) {
option (google.api.http) = {
patch: "/v1/{firewall_policy.name=projects/*/firewallpolicies/*}"
body: "firewall_policy"
};
option (google.api.method_signature) = "firewall_policy,update_mask";
}
// Deletes the specified firewall policy.
rpc DeleteFirewallPolicy(DeleteFirewallPolicyRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/firewallpolicies/*}"
};
option (google.api.method_signature) = "name";
}
// Reorders all firewall policies.
rpc ReorderFirewallPolicies(ReorderFirewallPoliciesRequest)
returns (ReorderFirewallPoliciesResponse) {
option (google.api.http) = {
post: "/v1/{parent=projects/*}/firewallpolicies:reorder"
body: "*"
};
option (google.api.method_signature) = "parent,names";
}
// List groups of related accounts.
rpc ListRelatedAccountGroups(ListRelatedAccountGroupsRequest)
returns (ListRelatedAccountGroupsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*}/relatedaccountgroups"
};
option (google.api.method_signature) = "parent";
}
// Get memberships in a group of related accounts.
rpc ListRelatedAccountGroupMemberships(
ListRelatedAccountGroupMembershipsRequest)
returns (ListRelatedAccountGroupMembershipsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/relatedaccountgroups/*}/memberships"
};
option (google.api.method_signature) = "parent";
}
// Search group memberships related to a given account.
rpc SearchRelatedAccountGroupMemberships(
SearchRelatedAccountGroupMembershipsRequest)
returns (SearchRelatedAccountGroupMembershipsResponse) {
option (google.api.http) = {
post: "/v1/{project=projects/*}/relatedaccountgroupmemberships:search"
body: "*"
};
option (google.api.method_signature) = "project,hashed_account_id";
}
}
// The create assessment request message.
message CreateAssessmentRequest {
// Required. The name of the project in which the assessment will be created,
// in the format `projects/{project}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "cloudresourcemanager.googleapis.com/Project"
}
];
// Required. The assessment details.
Assessment assessment = 2 [(google.api.field_behavior) = REQUIRED];
}
// Describes an event in the lifecycle of a payment transaction.
message TransactionEvent {
// Enum that represents an event in the payment transaction lifecycle.
enum TransactionEventType {
// Default, unspecified event type.
TRANSACTION_EVENT_TYPE_UNSPECIFIED = 0;
// Indicates that the transaction is approved by the merchant. The
// accompanying reasons can include terms such as 'INHOUSE', 'ACCERTIFY',
// 'CYBERSOURCE', or 'MANUAL_REVIEW'.
MERCHANT_APPROVE = 1;
// Indicates that the transaction is denied and concluded due to risks
// detected by the merchant. The accompanying reasons can include terms such
// as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'.
MERCHANT_DENY = 2;
// Indicates that the transaction is being evaluated by a human, due to
// suspicion or risk.
MANUAL_REVIEW = 3;
// Indicates that the authorization attempt with the card issuer succeeded.
AUTHORIZATION = 4;
// Indicates that the authorization attempt with the card issuer failed.
// The accompanying reasons can include Visa's '54' indicating that the card
// is expired, or '82' indicating that the CVV is incorrect.
AUTHORIZATION_DECLINE = 5;
// Indicates that the transaction is completed because the funds were
// settled.
PAYMENT_CAPTURE = 6;
// Indicates that the transaction could not be completed because the funds
// were not settled.
PAYMENT_CAPTURE_DECLINE = 7;
// Indicates that the transaction has been canceled. Specify the reason
// for the cancellation. For example, 'INSUFFICIENT_INVENTORY'.
CANCEL = 8;
// Indicates that the merchant has received a chargeback inquiry due to
// fraud for the transaction, requesting additional information before a
// fraud chargeback is officially issued and a formal chargeback
// notification is sent.
CHARGEBACK_INQUIRY = 9;
// Indicates that the merchant has received a chargeback alert due to fraud
// for the transaction. The process of resolving the dispute without
// involving the payment network is started.
CHARGEBACK_ALERT = 10;
// Indicates that a fraud notification is issued for the transaction, sent
// by the payment instrument's issuing bank because the transaction appears
// to be fraudulent. We recommend including TC40 or SAFE data in the
// `reason` field for this event type. For partial chargebacks, we recommend
// that you include an amount in the `value` field.
FRAUD_NOTIFICATION = 11;
// Indicates that the merchant is informed by the payment network that the
// transaction has entered the chargeback process due to fraud. Reason code
// examples include Discover's '6005' and '6041'. For partial chargebacks,
// we recommend that you include an amount in the `value` field.
CHARGEBACK = 12;
// Indicates that the transaction has entered the chargeback process due to
// fraud, and that the merchant has chosen to enter representment. Reason
// examples include Discover's '6005' and '6041'. For partial chargebacks,
// we recommend that you include an amount in the `value` field.
CHARGEBACK_REPRESENTMENT = 13;
// Indicates that the transaction has had a fraud chargeback which was
// illegitimate and was reversed as a result. For partial chargebacks, we
// recommend that you include an amount in the `value` field.
CHARGEBACK_REVERSE = 14;
// Indicates that the merchant has received a refund for a completed
// transaction. For partial refunds, we recommend that you include an amount
// in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of
// exempt tax)
REFUND_REQUEST = 15;
// Indicates that the merchant has received a refund request for this
// transaction, but that they have declined it. For partial refunds, we
// recommend that you include an amount in the `value` field. Reason
// example: 'TAX_EXEMPT' (partial refund of exempt tax)
REFUND_DECLINE = 16;
// Indicates that the completed transaction was refunded by the merchant.
// For partial refunds, we recommend that you include an amount in the
// `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt
// tax)
REFUND = 17;
// Indicates that the completed transaction was refunded by the merchant,
// and that this refund was reversed. For partial refunds, we recommend that
// you include an amount in the `value` field.
REFUND_REVERSE = 18;
}
// Optional. The type of this transaction event.
TransactionEventType event_type = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. The reason or standardized code that corresponds with this
// transaction event, if one exists. For example, a CHARGEBACK event with code
// 6005.
string reason = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. The value that corresponds with this transaction event, if one
// exists. For example, a refund event where $5.00 was refunded. Currency is
// obtained from the original transaction data.
double value = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. Timestamp when this transaction event occurred; otherwise assumed
// to be the time of the API call.
google.protobuf.Timestamp event_time = 4
[(google.api.field_behavior) = OPTIONAL];
}
// The request message to annotate an Assessment.
message AnnotateAssessmentRequest {
// Enum that represents the types of annotations.
enum Annotation {
// Default unspecified type.
ANNOTATION_UNSPECIFIED = 0;
// Provides information that the event turned out to be legitimate.
LEGITIMATE = 1;
// Provides information that the event turned out to be fraudulent.
FRAUDULENT = 2;
// Provides information that the event was related to a login event in which
// the user typed the correct password. Deprecated, prefer indicating
// CORRECT_PASSWORD through the reasons field instead.
PASSWORD_CORRECT = 3 [deprecated = true];
// Provides information that the event was related to a login event in which
// the user typed the incorrect password. Deprecated, prefer indicating
// INCORRECT_PASSWORD through the reasons field instead.
PASSWORD_INCORRECT = 4 [deprecated = true];
}
// Enum that represents potential reasons for annotating an assessment.
enum Reason {
// Default unspecified reason.
REASON_UNSPECIFIED = 0;
// Indicates that the transaction had a chargeback issued with no other
// details. When possible, specify the type by using CHARGEBACK_FRAUD or
// CHARGEBACK_DISPUTE instead.
CHARGEBACK = 1;
// Indicates that the transaction had a chargeback issued related to an
// alleged unauthorized transaction from the cardholder's perspective (for
// example, the card number was stolen).
CHARGEBACK_FRAUD = 8;
// Indicates that the transaction had a chargeback issued related to the
// cardholder having provided their card details but allegedly not being
// satisfied with the purchase (for example, misrepresentation, attempted
// cancellation).
CHARGEBACK_DISPUTE = 9;
// Indicates that the completed payment transaction was refunded by the
// seller.
REFUND = 10;
// Indicates that the completed payment transaction was determined to be
// fraudulent by the seller, and was cancelled and refunded as a result.
REFUND_FRAUD = 11;
// Indicates that the payment transaction was accepted, and the user was
// charged.
TRANSACTION_ACCEPTED = 12;
// Indicates that the payment transaction was declined, for example due to
// invalid card details.
TRANSACTION_DECLINED = 13;
// Indicates the transaction associated with the assessment is suspected of
// being fraudulent based on the payment method, billing details, shipping
// address or other transaction information.
PAYMENT_HEURISTICS = 2;
// Indicates that the user was served a 2FA challenge. An old assessment
// with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been
// overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow.
// This is equivalent to `FAILED_TWO_FACTOR`.
INITIATED_TWO_FACTOR = 7;
// Indicates that the user passed a 2FA challenge.
PASSED_TWO_FACTOR = 3;
// Indicates that the user failed a 2FA challenge.
FAILED_TWO_FACTOR = 4;
// Indicates the user provided the correct password.
CORRECT_PASSWORD = 5;
// Indicates the user provided an incorrect password.
INCORRECT_PASSWORD = 6;
// Indicates that the user sent unwanted and abusive messages to other users
// of the platform, such as spam, scams, phishing, or social engineering.
SOCIAL_SPAM = 14;
}
// Required. The resource name of the Assessment, in the format
// `projects/{project}/assessments/{assessment}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "recaptchaenterprise.googleapis.com/Assessment"
}
];
// Optional. The annotation that will be assigned to the Event. This field can
// be left empty to provide reasons that apply to an event without concluding
// whether the event is legitimate or fraudulent.
Annotation annotation = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. Reasons for the annotation that are assigned to the event.
repeated Reason reasons = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. A stable account identifier to apply to the assessment. This is
// an alternative to setting `account_id` in `CreateAssessment`, for example
// when a stable account identifier is not yet known in the initial request.
string account_id = 7 [(google.api.field_behavior) = OPTIONAL];
// Optional. A stable hashed account identifier to apply to the assessment.
// This is an alternative to setting `hashed_account_id` in
// `CreateAssessment`, for example when a stable account identifier is not yet
// known in the initial request.
bytes hashed_account_id = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. If the assessment is part of a payment transaction, provide
// details on payment lifecycle events that occur in the transaction.
TransactionEvent transaction_event = 5
[(google.api.field_behavior) = OPTIONAL];
}
// Empty response for AnnotateAssessment.
message AnnotateAssessmentResponse {}
// Information about a verification endpoint that can be used for 2FA.
message EndpointVerificationInfo {
oneof endpoint {
// Email address for which to trigger a verification request.
string email_address = 1;
// Phone number for which to trigger a verification request. Should be given
// in E.164 format.
string phone_number = 2;
}
// Output only. Token to provide to the client to trigger endpoint
// verification. It must be used within 15 minutes.
string request_token = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp of the last successful verification for the
// endpoint, if any.
google.protobuf.Timestamp last_verification_time = 4
[(google.api.field_behavior) = OUTPUT_ONLY];
}
// Information about account verification, used for identity verification.
message AccountVerificationInfo {
// Result of the account verification as contained in the verdict token issued
// at the end of the verification flow.
enum Result {
// No information about the latest account verification.
RESULT_UNSPECIFIED = 0;
// The user was successfully verified. This means the account verification
// challenge was successfully completed.
SUCCESS_USER_VERIFIED = 1;
// The user failed the verification challenge.
ERROR_USER_NOT_VERIFIED = 2;
// The site is not properly onboarded to use the account verification
// feature.
ERROR_SITE_ONBOARDING_INCOMPLETE = 3;
// The recipient is not allowed for account verification. This can occur
// during integration but should not occur in production.
ERROR_RECIPIENT_NOT_ALLOWED = 4;
// The recipient has already been sent too many verification codes in a
// short amount of time.
ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED = 5;
// The verification flow could not be completed due to a critical internal
// error.
ERROR_CRITICAL_INTERNAL = 6;
// The client has exceeded their two factor request quota for this period of
// time.
ERROR_CUSTOMER_QUOTA_EXHAUSTED = 7;
// The request cannot be processed at the time because of an incident. This
// bypass can be restricted to a problematic destination email domain, a
// customer, or could affect the entire service.
ERROR_VERIFICATION_BYPASSED = 8;
// The request parameters do not match with the token provided and cannot be
// processed.
ERROR_VERDICT_MISMATCH = 9;
}
// Optional. Endpoints that can be used for identity verification.
repeated EndpointVerificationInfo endpoints = 1
[(google.api.field_behavior) = OPTIONAL];
// Optional. Language code preference for the verification message, set as a
// IETF BCP 47 language code.
string language_code = 3 [(google.api.field_behavior) = OPTIONAL];
// Output only. Result of the latest account verification challenge.
Result latest_verification_result = 7
[(google.api.field_behavior) = OUTPUT_ONLY];
// Username of the account that is being verified. Deprecated. Customers
// should now provide the `account_id` field in `event.user_info`.
string username = 2 [deprecated = true];
}
// Private password leak verification info.
message PrivatePasswordLeakVerification {
// Required. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized
// username. It is used to look up password leaks associated with that hash
// prefix.
bytes lookup_hash_prefix = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. Encrypted Scrypt hash of the canonicalized username+password. It
// is re-encrypted by the server and returned through
// `reencrypted_user_credentials_hash`.
bytes encrypted_user_credentials_hash = 2
[(google.api.field_behavior) = OPTIONAL];
// Output only. List of prefixes of the encrypted potential password leaks
// that matched the given parameters. They must be compared with the
// client-side decryption prefix of `reencrypted_user_credentials_hash`
repeated bytes encrypted_leak_match_prefixes = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Corresponds to the re-encryption of the
// `encrypted_user_credentials_hash` field. It is used to match potential
// password leaks within `encrypted_leak_match_prefixes`.
bytes reencrypted_user_credentials_hash = 4
[(google.api.field_behavior) = OUTPUT_ONLY];
}
// A reCAPTCHA Enterprise assessment resource.
message Assessment {
option (google.api.resource) = {
type: "recaptchaenterprise.googleapis.com/Assessment"
pattern: "projects/{project}/assessments/{assessment}"
plural: "assessments"
singular: "assessment"
};
// Output only. Identifier. The resource name for the Assessment in the format
// `projects/{project}/assessments/{assessment}`.
string name = 1 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.field_behavior) = IDENTIFIER
];
// Optional. The event being assessed.
Event event = 2 [(google.api.field_behavior) = OPTIONAL];
// Output only. The risk analysis result for the event being assessed.
RiskAnalysis risk_analysis = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Properties of the provided event token.
TokenProperties token_properties = 4
[(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. Account verification information for identity verification. The
// assessment event must include a token and site key to use this feature.
AccountVerificationInfo account_verification = 5
[(google.api.field_behavior) = OPTIONAL];
// Output only. Assessment returned by account defender when an account
// identifier is provided.
AccountDefenderAssessment account_defender_assessment = 6
[(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. The private password leak verification field contains the
// parameters that are used to to check for leaks privately without sharing
// user credentials.
PrivatePasswordLeakVerification private_password_leak_verification = 8
[(google.api.field_behavior) = OPTIONAL];
// Output only. Assessment returned when firewall policies belonging to the
// project are evaluated using the field firewall_policy_evaluation.
FirewallPolicyAssessment firewall_policy_assessment = 10
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Assessment returned by Fraud Prevention when TransactionData
// is provided.
FraudPreventionAssessment fraud_prevention_assessment = 11
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Fraud Signals specific to the users involved in a payment
// transaction.
FraudSignals fraud_signals = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The event being assessed.
message Event {
// Optional. The user response token provided by the reCAPTCHA Enterprise
// client-side integration on your site.
string token = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. The site key that was used to invoke reCAPTCHA Enterprise on your
// site and generate the token.
string site_key = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. The user agent present in the request from the user's device
// related to this event.
string user_agent = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. The IP address in the request from the user's device related to
// this event.
string user_ip_address = 4 [
(google.api.field_info).format = IPV4_OR_IPV6,
(google.api.field_behavior) = OPTIONAL
];
// Optional. The expected action for this type of event. This should be the
// same action provided at token generation time on client-side platforms
// already integrated with recaptcha enterprise.
string expected_action = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional. Deprecated: use `user_info.account_id` instead.
// Unique stable hashed user identifier for the request. The identifier must
// be hashed using hmac-sha256 with stable secret.
bytes hashed_account_id = 6
[deprecated = true, (google.api.field_behavior) = OPTIONAL];
// Optional. Flag for a reCAPTCHA express request for an assessment without a
// token. If enabled, `site_key` must reference a SCORE key with WAF feature
// set to EXPRESS.
bool express = 14 [(google.api.field_behavior) = OPTIONAL];
// Optional. The URI resource the user requested that triggered an assessment.
string requested_uri = 8 [(google.api.field_behavior) = OPTIONAL];
// Optional. Flag for running WAF token assessment.
// If enabled, the token must be specified, and have been created by a
// WAF-enabled key.
bool waf_token_assessment = 9 [(google.api.field_behavior) = OPTIONAL];
// Optional. JA3 fingerprint for SSL clients.
string ja3 = 10 [(google.api.field_behavior) = OPTIONAL];
// Optional. HTTP header information about the request.
repeated string headers = 11 [(google.api.field_behavior) = OPTIONAL];
// Optional. Flag for enabling firewall policy config assessment.
// If this flag is enabled, the firewall policy will be evaluated and a
// suggested firewall action will be returned in the response.
bool firewall_policy_evaluation = 12 [(google.api.field_behavior) = OPTIONAL];
// Optional. Data describing a payment transaction to be assessed. Sending
// this data enables reCAPTCHA Enterprise Fraud Prevention and the
// FraudPreventionAssessment component in the response.
TransactionData transaction_data = 13
[(google.api.field_behavior) = OPTIONAL];
// Optional. Information about the user that generates this event, when they
// can be identified. They are often identified through the use of an account
// for logged-in requests or login/registration requests, or by providing user
// identifiers for guest actions like checkout.
UserInfo user_info = 15 [(google.api.field_behavior) = OPTIONAL];
}
// Transaction data associated with a payment protected by reCAPTCHA Enterprise.
message TransactionData {
// Structured address format for billing and shipping addresses.
message Address {
// Optional. The recipient name, potentially including information such as
// "care of".
string recipient = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. The first lines of the address. The first line generally
// contains the street name and number, and further lines may include
// information such as an apartment number.
repeated string address = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. The town/city of the address.
string locality = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. The state, province, or otherwise administrative area of the
// address.
string administrative_area = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. The CLDR country/region of the address.
string region_code = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional. The postal or ZIP code of the address.
string postal_code = 6 [(google.api.field_behavior) = OPTIONAL];
}
// Details about a user's account involved in the transaction.
message User {
// Optional. Unique account identifier for this user. If using account
// defender, this should match the hashed_account_id field. Otherwise, a
// unique and persistent identifier for this account.
string account_id = 6 [(google.api.field_behavior) = OPTIONAL];
// Optional. The epoch milliseconds of the user's account creation.
int64 creation_ms = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. The email address of the user.
string email = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. Whether the email has been verified to be accessible by the
// user (OTP or similar).
bool email_verified = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. The phone number of the user, with country code.
string phone_number = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. Whether the phone number has been verified to be accessible by
// the user (OTP or similar).
bool phone_verified = 5 [(google.api.field_behavior) = OPTIONAL];
}
// Line items being purchased in this transaction.
message Item {
// Optional. The full name of the item.
string name = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. The value per item that the user is paying, in the transaction
// currency, after discounts.
double value = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. The quantity of this item that is being purchased.
int64 quantity = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. When a merchant is specified, its corresponding account_id.
// Necessary to populate marketplace-style transactions.
string merchant_account_id = 4 [(google.api.field_behavior) = OPTIONAL];
}
// Details about the transaction from the gateway.
message GatewayInfo {
// Optional. Name of the gateway service (for example, stripe, square,
// paypal).
string name = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. Gateway response code describing the state of the transaction.
string gateway_response_code = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. AVS response code from the gateway
// (available only when reCAPTCHA Enterprise is called after authorization).
string avs_response_code = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. CVV response code from the gateway
// (available only when reCAPTCHA Enterprise is called after authorization).
string cvv_response_code = 4 [(google.api.field_behavior) = OPTIONAL];
}
// Unique identifier for the transaction. This custom identifier can be used
// to reference this transaction in the future, for example, labeling a refund
// or chargeback event. Two attempts at the same transaction should use the
// same transaction id.
optional string transaction_id = 11;
// Optional. The payment method for the transaction. The allowed values are:
//
// * credit-card
// * debit-card
// * gift-card
// * processor-{name} (If a third-party is used, for example,
// processor-paypal)
// * custom-{name} (If an alternative method is used, for example,
// custom-crypto)
string payment_method = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. The Bank Identification Number - generally the first 6 or 8
// digits of the card.
string card_bin = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. The last four digits of the card.
string card_last_four = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. The currency code in ISO-4217 format.
string currency_code = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. The decimal value of the transaction in the specified currency.
double value = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional. The value of shipping in the specified currency. 0 for free or no
// shipping.
double shipping_value = 12 [(google.api.field_behavior) = OPTIONAL];
// Optional. Destination address if this transaction involves shipping a
// physical item.
Address shipping_address = 6 [(google.api.field_behavior) = OPTIONAL];
// Optional. Address associated with the payment method when applicable.
Address billing_address = 7 [(google.api.field_behavior) = OPTIONAL];
// Optional. Information about the user paying/initiating the transaction.
User user = 8 [(google.api.field_behavior) = OPTIONAL];
// Optional. Information about the user or users fulfilling the transaction.
repeated User merchants = 13 [(google.api.field_behavior) = OPTIONAL];
// Optional. Items purchased in this transaction.
repeated Item items = 14 [(google.api.field_behavior) = OPTIONAL];
// Optional. Information about the payment gateway's response to the
// transaction.
GatewayInfo gateway_info = 10 [(google.api.field_behavior) = OPTIONAL];
}
// User information associated with a request protected by reCAPTCHA Enterprise.
message UserInfo {
// Optional. Creation time for this account associated with this user. Leave
// blank for non logged-in actions, guest checkout, or when there is no
// account associated with the current user.
google.protobuf.Timestamp create_account_time = 1
[(google.api.field_behavior) = OPTIONAL];
// Optional. For logged-in requests or login/registration requests, the unique
// account identifier associated with this user. You can use the username if
// it is stable (meaning it is the same for every request associated with the
// same user), or any stable user ID of your choice. Leave blank for non
// logged-in actions or guest checkout.
string account_id = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. Identifiers associated with this user or request.
repeated UserId user_ids = 3 [(google.api.field_behavior) = OPTIONAL];
}
// An identifier associated with a user.
message UserId {
oneof id_oneof {
// Optional. An email address.
string email = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. A phone number. Should use the E.164 format.
string phone_number = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. A unique username, if different from all the other identifiers
// and `account_id` that are provided. Can be a unique login handle or
// display name for a user.
string username = 3 [(google.api.field_behavior) = OPTIONAL];
}
}
// Risk analysis result for an event.
message RiskAnalysis {
// Reasons contributing to the risk analysis verdict.
enum ClassificationReason {
// Default unspecified type.
CLASSIFICATION_REASON_UNSPECIFIED = 0;
// Interactions matched the behavior of an automated agent.
AUTOMATION = 1;
// The event originated from an illegitimate environment.
UNEXPECTED_ENVIRONMENT = 2;
// Traffic volume from the event source is higher than normal.
TOO_MUCH_TRAFFIC = 3;
// Interactions with the site were significantly different than expected
// patterns.
UNEXPECTED_USAGE_PATTERNS = 4;
// Too little traffic has been received from this site thus far to generate
// quality risk analysis.
LOW_CONFIDENCE_SCORE = 5;
// The request matches behavioral characteristics of a carding attack.
SUSPECTED_CARDING = 6;
// The request matches behavioral characteristics of chargebacks for fraud.
SUSPECTED_CHARGEBACK = 7;
}
// Output only. Legitimate event score from 0.0 to 1.0.
// (1.0 means very likely legitimate traffic while 0.0 means very likely
// non-legitimate traffic).
float score = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Reasons contributing to the risk analysis verdict.
repeated ClassificationReason reasons = 2
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Extended verdict reasons to be used for experimentation only.
// The set of possible reasons is subject to change.
repeated string extended_verdict_reasons = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
}
// Properties of the provided event token.
message TokenProperties {
// Enum that represents the types of invalid token reasons.
enum InvalidReason {
// Default unspecified type.
INVALID_REASON_UNSPECIFIED = 0;
// If the failure reason was not accounted for.
UNKNOWN_INVALID_REASON = 1;
// The provided user verification token was malformed.
MALFORMED = 2;
// The user verification token had expired.
EXPIRED = 3;
// The user verification had already been seen.
DUPE = 4;
// The user verification token was not present.
MISSING = 5;
// A retriable error (such as network failure) occurred on the browser.
// Could easily be simulated by an attacker.
BROWSER_ERROR = 6;
}
// Output only. Whether the provided user response token is valid. When valid
// = false, the reason could be specified in invalid_reason or it could also
// be due to a user failing to solve a challenge or a sitekey mismatch (i.e
// the sitekey used to generate the token was different than the one specified
// in the assessment).
bool valid = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Reason associated with the response when valid = false.
InvalidReason invalid_reason = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The timestamp corresponding to the generation of the token.
google.protobuf.Timestamp create_time = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The hostname of the page on which the token was generated (Web
// keys only).
string hostname = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The name of the Android package with which the token was
// generated (Android keys only).
string android_package_name = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The ID of the iOS bundle with which the token was generated
// (iOS keys only).
string ios_bundle_id = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Action name provided at token generation.
string action = 5 [(google.api.field_behavior) = OUTPUT_ONLY];