/
recaptchaenterprise.v1.json
1404 lines (1404 loc) 路 64.5 KB
/
recaptchaenterprise.v1.json
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
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://recaptchaenterprise.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Recaptcha Enterprise",
"description": "Help protect your website from fraudulent activity, spam, and abuse without creating friction.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/recaptcha-enterprise/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "recaptchaenterprise:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://recaptchaenterprise.mtls.googleapis.com/",
"name": "recaptchaenterprise",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"assessments": {
"methods": {
"annotate": {
"description": "Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.",
"flatPath": "v1/projects/{projectsId}/assessments/{assessmentsId}:annotate",
"httpMethod": "POST",
"id": "recaptchaenterprise.projects.assessments.annotate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Assessment, in the format \"projects/{project}/assessments/{assessment}\".",
"location": "path",
"pattern": "^projects/[^/]+/assessments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:annotate",
"request": {
"$ref": "GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest"
},
"response": {
"$ref": "GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates an Assessment of the likelihood an event is legitimate.",
"flatPath": "v1/projects/{projectsId}/assessments",
"httpMethod": "POST",
"id": "recaptchaenterprise.projects.assessments.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the project in which the assessment will be created, in the format \"projects/{project}\".",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/assessments",
"request": {
"$ref": "GoogleCloudRecaptchaenterpriseV1Assessment"
},
"response": {
"$ref": "GoogleCloudRecaptchaenterpriseV1Assessment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"keys": {
"methods": {
"create": {
"description": "Creates a new reCAPTCHA Enterprise key.",
"flatPath": "v1/projects/{projectsId}/keys",
"httpMethod": "POST",
"id": "recaptchaenterprise.projects.keys.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the project in which the key will be created, in the format \"projects/{project}\".",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/keys",
"request": {
"$ref": "GoogleCloudRecaptchaenterpriseV1Key"
},
"response": {
"$ref": "GoogleCloudRecaptchaenterpriseV1Key"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the specified key.",
"flatPath": "v1/projects/{projectsId}/keys/{keysId}",
"httpMethod": "DELETE",
"id": "recaptchaenterprise.projects.keys.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the key to be deleted, in the format \"projects/{project}/keys/{key}\".",
"location": "path",
"pattern": "^projects/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns the specified key.",
"flatPath": "v1/projects/{projectsId}/keys/{keysId}",
"httpMethod": "GET",
"id": "recaptchaenterprise.projects.keys.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the requested key, in the format \"projects/{project}/keys/{key}\".",
"location": "path",
"pattern": "^projects/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudRecaptchaenterpriseV1Key"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getMetrics": {
"description": "Get some aggregated metrics for a Key. This data can be used to build dashboards.",
"flatPath": "v1/projects/{projectsId}/keys/{keysId}/metrics",
"httpMethod": "GET",
"id": "recaptchaenterprise.projects.keys.getMetrics",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the requested metrics, in the format \"projects/{project}/keys/{key}/metrics\".",
"location": "path",
"pattern": "^projects/[^/]+/keys/[^/]+/metrics$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudRecaptchaenterpriseV1Metrics"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Returns the list of all keys that belong to a project.",
"flatPath": "v1/projects/{projectsId}/keys",
"httpMethod": "GET",
"id": "recaptchaenterprise.projects.keys.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of keys to return. Default is 10. Max limit is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The next_page_token value returned from a previous. ListKeysRequest, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the project that contains the keys that will be listed, in the format \"projects/{project}\".",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/keys",
"response": {
"$ref": "GoogleCloudRecaptchaenterpriseV1ListKeysResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"migrate": {
"description": "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 Site Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.",
"flatPath": "v1/projects/{projectsId}/keys/{keysId}:migrate",
"httpMethod": "POST",
"id": "recaptchaenterprise.projects.keys.migrate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the key to be migrated, in the format \"projects/{project}/keys/{key}\".",
"location": "path",
"pattern": "^projects/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:migrate",
"request": {
"$ref": "GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest"
},
"response": {
"$ref": "GoogleCloudRecaptchaenterpriseV1Key"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the specified key.",
"flatPath": "v1/projects/{projectsId}/keys/{keysId}",
"httpMethod": "PATCH",
"id": "recaptchaenterprise.projects.keys.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource name for the Key in the format \"projects/{project}/keys/{key}\".",
"location": "path",
"pattern": "^projects/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudRecaptchaenterpriseV1Key"
},
"response": {
"$ref": "GoogleCloudRecaptchaenterpriseV1Key"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"retrieveLegacySecretKey": {
"description": "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.",
"flatPath": "v1/projects/{projectsId}/keys/{keysId}:retrieveLegacySecretKey",
"httpMethod": "GET",
"id": "recaptchaenterprise.projects.keys.retrieveLegacySecretKey",
"parameterOrder": [
"key"
],
"parameters": {
"key": {
"description": "Required. The public key name linked to the requested secret key in the format \"projects/{project}/keys/{key}\".",
"location": "path",
"pattern": "^projects/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+key}:retrieveLegacySecretKey",
"response": {
"$ref": "GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"relatedaccountgroupmemberships": {
"methods": {
"search": {
"description": "Search group memberships related to a given account.",
"flatPath": "v1/projects/{projectsId}/relatedaccountgroupmemberships:search",
"httpMethod": "POST",
"id": "recaptchaenterprise.projects.relatedaccountgroupmemberships.search",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Required. The name of the project to search related account group memberships from. Specify the project name in the following format: \"projects/{project}\".",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+project}/relatedaccountgroupmemberships:search",
"request": {
"$ref": "GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest"
},
"response": {
"$ref": "GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"relatedaccountgroups": {
"methods": {
"list": {
"description": "List groups of related accounts.",
"flatPath": "v1/projects/{projectsId}/relatedaccountgroups",
"httpMethod": "GET",
"id": "recaptchaenterprise.projects.relatedaccountgroups.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of groups to return. The service might return fewer than this value. If unspecified, at most 50 groups are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListRelatedAccountGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRelatedAccountGroups` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the project to list related account groups from, in the format \"projects/{project}\".",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/relatedaccountgroups",
"response": {
"$ref": "GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"memberships": {
"methods": {
"list": {
"description": "Get memberships in a group of related accounts.",
"flatPath": "v1/projects/{projectsId}/relatedaccountgroups/{relatedaccountgroupsId}/memberships",
"httpMethod": "GET",
"id": "recaptchaenterprise.projects.relatedaccountgroups.memberships.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of accounts to return. The service might return fewer than this value. If unspecified, at most 50 accounts are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListRelatedAccountGroupMemberships` call. When paginating, all other parameters provided to `ListRelatedAccountGroupMemberships` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name for the related account group in the format `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.",
"location": "path",
"pattern": "^projects/[^/]+/relatedaccountgroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/memberships",
"response": {
"$ref": "GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20230129",
"rootUrl": "https://recaptchaenterprise.googleapis.com/",
"schemas": {
"GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": {
"description": "Account defender risk assessment.",
"id": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment",
"properties": {
"labels": {
"description": "Labels for this request.",
"items": {
"enum": [
"ACCOUNT_DEFENDER_LABEL_UNSPECIFIED",
"PROFILE_MATCH",
"SUSPICIOUS_LOGIN_ACTIVITY",
"SUSPICIOUS_ACCOUNT_CREATION",
"RELATED_ACCOUNTS_NUMBER_HIGH"
],
"enumDescriptions": [
"Default unspecified type.",
"The request matches a known good profile for the user.",
"The request is potentially a suspicious login event and must be further verified either through multi-factor authentication or another system.",
"The request matched a profile that previously had suspicious account creation behavior. This can mean that this is a fake account.",
"The account in the request has a high number of related accounts. It does not necessarily imply that the account is bad but can require further investigation."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo": {
"description": "Information about account verification, used for identity verification.",
"id": "GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo",
"properties": {
"endpoints": {
"description": "Endpoints that can be used for identity verification.",
"items": {
"$ref": "GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo"
},
"type": "array"
},
"languageCode": {
"description": "Language code preference for the verification message, set as a IETF BCP 47 language code.",
"type": "string"
},
"latestVerificationResult": {
"description": "Output only. Result of the latest account verification challenge.",
"enum": [
"RESULT_UNSPECIFIED",
"SUCCESS_USER_VERIFIED",
"ERROR_USER_NOT_VERIFIED",
"ERROR_SITE_ONBOARDING_INCOMPLETE",
"ERROR_RECIPIENT_NOT_ALLOWED",
"ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED",
"ERROR_CRITICAL_INTERNAL",
"ERROR_CUSTOMER_QUOTA_EXHAUSTED",
"ERROR_VERIFICATION_BYPASSED",
"ERROR_VERDICT_MISMATCH"
],
"enumDescriptions": [
"No information about the latest account verification.",
"The user was successfully verified. This means the account verification challenge was successfully completed.",
"The user failed the verification challenge.",
"The site is not properly onboarded to use the account verification feature.",
"The recipient is not allowed for account verification. This can occur during integration but should not occur in production.",
"The recipient has already been sent too many verification codes in a short amount of time.",
"The verification flow could not be completed due to a critical internal error.",
"The client has exceeded their two factor request quota for this period of time.",
"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.",
"The request parameters do not match with the token provided and cannot be processed."
],
"readOnly": true,
"type": "string"
},
"username": {
"description": "Username of the account that is being verified. Deprecated. Customers should now provide the hashed account ID field in Event.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1AndroidKeySettings": {
"description": "Settings specific to keys that can be used by Android apps.",
"id": "GoogleCloudRecaptchaenterpriseV1AndroidKeySettings",
"properties": {
"allowAllPackageNames": {
"description": "If set to true, allowed_package_names are not enforced.",
"type": "boolean"
},
"allowedPackageNames": {
"description": "Android package names of apps allowed to use the key. Example: 'com.companyname.appname'",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest": {
"description": "The request message to annotate an Assessment.",
"id": "GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest",
"properties": {
"annotation": {
"description": "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.",
"enum": [
"ANNOTATION_UNSPECIFIED",
"LEGITIMATE",
"FRAUDULENT",
"PASSWORD_CORRECT",
"PASSWORD_INCORRECT"
],
"enumDescriptions": [
"Default unspecified type.",
"Provides information that the event turned out to be legitimate.",
"Provides information that the event turned out to be fraudulent.",
"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.",
"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."
],
"type": "string"
},
"hashedAccountId": {
"description": "Optional. Unique stable hashed user identifier to apply to the assessment. This is an alternative to setting the hashed_account_id in CreateAssessment, for example when the account identifier is not yet known in the initial request. It is recommended that the identifier is hashed using hmac-sha256 with stable secret.",
"format": "byte",
"type": "string"
},
"reasons": {
"description": "Optional. Optional reasons for the annotation that will be assigned to the Event.",
"items": {
"enum": [
"REASON_UNSPECIFIED",
"CHARGEBACK",
"CHARGEBACK_FRAUD",
"CHARGEBACK_DISPUTE",
"REFUND",
"REFUND_FRAUD",
"TRANSACTION_ACCEPTED",
"TRANSACTION_DECLINED",
"PAYMENT_HEURISTICS",
"INITIATED_TWO_FACTOR",
"PASSED_TWO_FACTOR",
"FAILED_TWO_FACTOR",
"CORRECT_PASSWORD",
"INCORRECT_PASSWORD",
"SOCIAL_SPAM"
],
"enumDescriptions": [
"Default unspecified reason.",
"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.",
"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).",
"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).",
"Indicates that the completed payment transaction was refunded by the seller.",
"Indicates that the completed payment transaction was determined to be fraudulent by the seller, and was cancelled and refunded as a result.",
"Indicates that the payment transaction was accepted, and the user was charged.",
"Indicates that the payment transaction was declined, for example due to invalid card details.",
"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.",
"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`.",
"Indicates that the user passed a 2FA challenge.",
"Indicates that the user failed a 2FA challenge.",
"Indicates the user provided the correct password.",
"Indicates the user provided an incorrect password.",
"Indicates that the user sent unwanted and abusive messages to other users of the platform, such as spam, scams, phishing, or social engineering."
],
"type": "string"
},
"type": "array"
},
"transactionEvent": {
"$ref": "GoogleCloudRecaptchaenterpriseV1TransactionEvent",
"description": "Optional. If the Assessment is part of a Payment Transaction, provide details on Payment Lifecycle Events that occur in the Transaction."
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse": {
"description": "Empty response for AnnotateAssessment.",
"id": "GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse",
"properties": {},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1Assessment": {
"description": "A reCAPTCHA Enterprise assessment resource.",
"id": "GoogleCloudRecaptchaenterpriseV1Assessment",
"properties": {
"accountDefenderAssessment": {
"$ref": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment",
"description": "Assessment returned by account defender when a hashed_account_id is provided."
},
"accountVerification": {
"$ref": "GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo",
"description": "Account verification information for identity verification. The assessment event must include a token and site key to use this feature."
},
"event": {
"$ref": "GoogleCloudRecaptchaenterpriseV1Event",
"description": "The event being assessed."
},
"name": {
"description": "Output only. The resource name for the Assessment in the format \"projects/{project}/assessments/{assessment}\".",
"readOnly": true,
"type": "string"
},
"privatePasswordLeakVerification": {
"$ref": "GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification",
"description": "The private password leak verification field contains the parameters that are used to to check for leaks privately without sharing user credentials."
},
"riskAnalysis": {
"$ref": "GoogleCloudRecaptchaenterpriseV1RiskAnalysis",
"description": "Output only. The risk analysis result for the event being assessed.",
"readOnly": true
},
"tokenProperties": {
"$ref": "GoogleCloudRecaptchaenterpriseV1TokenProperties",
"description": "Output only. Properties of the provided event token.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1ChallengeMetrics": {
"description": "Metrics related to challenges.",
"id": "GoogleCloudRecaptchaenterpriseV1ChallengeMetrics",
"properties": {
"failedCount": {
"description": "Count of submitted challenge solutions that were incorrect or otherwise deemed suspicious such that a subsequent challenge was triggered.",
"format": "int64",
"type": "string"
},
"nocaptchaCount": {
"description": "Count of nocaptchas (successful verification without a challenge) issued.",
"format": "int64",
"type": "string"
},
"pageloadCount": {
"description": "Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to a count of pageloads for pages that include reCAPTCHA.",
"format": "int64",
"type": "string"
},
"passedCount": {
"description": "Count of nocaptchas (successful verification without a challenge) plus submitted challenge solutions that were correct and resulted in verification.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo": {
"description": "Information about a verification endpoint that can be used for 2FA.",
"id": "GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo",
"properties": {
"emailAddress": {
"description": "Email address for which to trigger a verification request.",
"type": "string"
},
"lastVerificationTime": {
"description": "Output only. Timestamp of the last successful verification for the endpoint, if any.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"phoneNumber": {
"description": "Phone number for which to trigger a verification request. Should be given in E.164 format.",
"type": "string"
},
"requestToken": {
"description": "Output only. Token to provide to the client to trigger endpoint verification. It must be used within 15 minutes.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1Event": {
"id": "GoogleCloudRecaptchaenterpriseV1Event",
"properties": {
"expectedAction": {
"description": "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.",
"type": "string"
},
"hashedAccountId": {
"description": "Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.",
"format": "byte",
"type": "string"
},
"siteKey": {
"description": "Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.",
"type": "string"
},
"token": {
"description": "Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.",
"type": "string"
},
"userAgent": {
"description": "Optional. The user agent present in the request from the user's device related to this event.",
"type": "string"
},
"userIpAddress": {
"description": "Optional. The IP address in the request from the user's device related to this event.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1IOSKeySettings": {
"description": "Settings specific to keys that can be used by iOS apps.",
"id": "GoogleCloudRecaptchaenterpriseV1IOSKeySettings",
"properties": {
"allowAllBundleIds": {
"description": "If set to true, allowed_bundle_ids are not enforced.",
"type": "boolean"
},
"allowedBundleIds": {
"description": "iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1Key": {
"description": "A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.",
"id": "GoogleCloudRecaptchaenterpriseV1Key",
"properties": {
"androidSettings": {
"$ref": "GoogleCloudRecaptchaenterpriseV1AndroidKeySettings",
"description": "Settings for keys that can be used by Android apps."
},
"createTime": {
"description": "The timestamp corresponding to the creation of this Key.",
"format": "google-datetime",
"type": "string"
},
"displayName": {
"description": "Human-readable display name of this key. Modifiable by user.",
"type": "string"
},
"iosSettings": {
"$ref": "GoogleCloudRecaptchaenterpriseV1IOSKeySettings",
"description": "Settings for keys that can be used by iOS apps."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "See Creating and managing labels.",
"type": "object"
},
"name": {
"description": "The resource name for the Key in the format \"projects/{project}/keys/{key}\".",
"type": "string"
},
"testingOptions": {
"$ref": "GoogleCloudRecaptchaenterpriseV1TestingOptions",
"description": "Options for user acceptance testing."
},
"wafSettings": {
"$ref": "GoogleCloudRecaptchaenterpriseV1WafSettings",
"description": "Settings for WAF"
},
"webSettings": {
"$ref": "GoogleCloudRecaptchaenterpriseV1WebKeySettings",
"description": "Settings for keys that can be used by websites."
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1ListKeysResponse": {
"description": "Response to request to list keys in a project.",
"id": "GoogleCloudRecaptchaenterpriseV1ListKeysResponse",
"properties": {
"keys": {
"description": "Key details.",
"items": {
"$ref": "GoogleCloudRecaptchaenterpriseV1Key"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results. It is set to empty if no keys remain in results.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse": {
"description": "The response to a `ListRelatedAccountGroupMemberships` call.",
"id": "GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"relatedAccountGroupMemberships": {
"description": "The memberships listed by the query.",
"items": {
"$ref": "GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse": {
"description": "The response to a `ListRelatedAccountGroups` call.",
"id": "GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"relatedAccountGroups": {
"description": "The groups of related accounts listed by the query.",
"items": {
"$ref": "GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1Metrics": {
"description": "Metrics for a single Key.",
"id": "GoogleCloudRecaptchaenterpriseV1Metrics",
"properties": {
"challengeMetrics": {
"description": "Metrics will be continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have challenge-based data.",
"items": {
"$ref": "GoogleCloudRecaptchaenterpriseV1ChallengeMetrics"
},
"type": "array"
},
"name": {
"description": "Output only. The name of the metrics, in the format \"projects/{project}/keys/{key}/metrics\".",
"readOnly": true,
"type": "string"
},
"scoreMetrics": {
"description": "Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.",
"items": {
"$ref": "GoogleCloudRecaptchaenterpriseV1ScoreMetrics"
},
"type": "array"
},
"startTime": {
"description": "Inclusive start time aligned to a day (UTC).",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest": {
"description": "The migrate key request message.",
"id": "GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest",
"properties": {
"skipBillingCheck": {
"description": "Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha-enterprise/docs/billing-information.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification": {
"description": "Private password leak verification info.",
"id": "GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification",
"properties": {
"encryptedLeakMatchPrefixes": {
"description": "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`",
"items": {
"format": "byte",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"encryptedUserCredentialsHash": {
"description": "Optional. Encrypted Scrypt hash of the canonicalized username+password. It is re-encrypted by the server and returned through `reencrypted_user_credentials_hash`.",
"format": "byte",
"type": "string"
},
"lookupHashPrefix": {
"description": "Optional. 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.",