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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="recaptchaenterprise_v1.html">reCAPTCHA Enterprise API</a> . <a href="recaptchaenterprise_v1.projects.html">projects</a> . <a href="recaptchaenterprise_v1.projects.keys.html">keys</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#addIpOverride">addIpOverride(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 1000. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new reCAPTCHA Enterprise key.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified key.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the specified key.</p>
<p class="toc_element">
<code><a href="#getMetrics">getMetrics(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get some aggregated metrics for a Key. This data can be used to build dashboards.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of all keys that belong to a project.</p>
<p class="toc_element">
<code><a href="#listIpOverrides">listIpOverrides(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all IP overrides for a key.</p>
<p class="toc_element">
<code><a href="#listIpOverrides_next">listIpOverrides_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#migrate">migrate(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified key.</p>
<p class="toc_element">
<code><a href="#removeIpOverride">removeIpOverride(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a `NOT_FOUND` error is returned. * If the IP is found in an existing IP override, but the override type does not match, a `NOT_FOUND` error is returned.</p>
<p class="toc_element">
<code><a href="#retrieveLegacySecretKey">retrieveLegacySecretKey(x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="addIpOverride">addIpOverride(name, body=None, x__xgafv=None)</code>
<pre>Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 1000. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.
Args:
name: string, Required. The name of the key to which the IP override is added, in the format `projects/{project}/keys/{key}`. (required)
body: object, The request body.
The object takes the form of:
{ # The AddIpOverride request message.
"ipOverrideData": { # Information about the IP or IP range override. # Required. IP override added to the key.
"ip": "A String", # Required. The IP address to override (can be IPv4, IPv6 or CIDR). The IP override must be a valid IPv4 or IPv6 address, or a CIDR range. The IP override must be a public IP address. Example of IPv4: 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: 2001:0DB8:1234::/48
"overrideType": "A String", # Required. Describes the type of IP override.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for AddIpOverride.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new reCAPTCHA Enterprise key.
Args:
parent: string, Required. The name of the project in which the key is created, in the format `projects/{project}`. (required)
body: object, The request body.
The object takes the form of:
{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
"allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
"supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
},
"createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
"displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
"expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
},
"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
"allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
"appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
"keyId": "A String", # Required. The Apple developer key ID (10-character string).
"privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
},
},
"labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
"testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
},
"wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
"wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
"wafService": "A String", # Required. The WAF service that uses this key.
},
"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
"allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
"allowAmpTraffic": True or False, # Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
"allowedDomains": [ # Optional. Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
"A String",
],
"challengeSecurityPreference": "A String", # Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for `IntegrationType` CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.
"challengeSettings": { # Settings for POLICY_BASED_CHALLENGE keys to control when a challenge is triggered. # Optional. Challenge settings.
"actionSettings": { # Optional. The action to score threshold map. The action name should be the same as the action name passed in the `data-action` attribute (see https://cloud.google.com/recaptcha/docs/actions-website). Action names are case-insensitive. There is a maximum of 100 action settings. An action name has a maximum length of 100.
"a_key": { # Per-action challenge settings.
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"defaultSettings": { # Per-action challenge settings. # Required. Defines when a challenge is triggered (unless the default threshold is overridden for the given action, see `action_settings`).
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"integrationType": "A String", # Required. Describes how this key is integrated with the website.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
"allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
"supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
},
"createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
"displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
"expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
},
"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
"allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
"appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
"keyId": "A String", # Required. The Apple developer key ID (10-character string).
"privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
},
},
"labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
"testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
},
"wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
"wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
"wafService": "A String", # Required. The WAF service that uses this key.
},
"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
"allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
"allowAmpTraffic": True or False, # Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
"allowedDomains": [ # Optional. Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
"A String",
],
"challengeSecurityPreference": "A String", # Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for `IntegrationType` CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.
"challengeSettings": { # Settings for POLICY_BASED_CHALLENGE keys to control when a challenge is triggered. # Optional. Challenge settings.
"actionSettings": { # Optional. The action to score threshold map. The action name should be the same as the action name passed in the `data-action` attribute (see https://cloud.google.com/recaptcha/docs/actions-website). Action names are case-insensitive. There is a maximum of 100 action settings. An action name has a maximum length of 100.
"a_key": { # Per-action challenge settings.
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"defaultSettings": { # Per-action challenge settings. # Required. Defines when a challenge is triggered (unless the default threshold is overridden for the given action, see `action_settings`).
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"integrationType": "A String", # Required. Describes how this key is integrated with the website.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes the specified key.
Args:
name: string, Required. The name of the key to be deleted, in the format `projects/{project}/keys/{key}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Returns the specified key.
Args:
name: string, Required. The name of the requested key, in the format `projects/{project}/keys/{key}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
"allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
"supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
},
"createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
"displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
"expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
},
"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
"allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
"appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
"keyId": "A String", # Required. The Apple developer key ID (10-character string).
"privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
},
},
"labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
"testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
},
"wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
"wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
"wafService": "A String", # Required. The WAF service that uses this key.
},
"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
"allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
"allowAmpTraffic": True or False, # Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
"allowedDomains": [ # Optional. Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
"A String",
],
"challengeSecurityPreference": "A String", # Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for `IntegrationType` CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.
"challengeSettings": { # Settings for POLICY_BASED_CHALLENGE keys to control when a challenge is triggered. # Optional. Challenge settings.
"actionSettings": { # Optional. The action to score threshold map. The action name should be the same as the action name passed in the `data-action` attribute (see https://cloud.google.com/recaptcha/docs/actions-website). Action names are case-insensitive. There is a maximum of 100 action settings. An action name has a maximum length of 100.
"a_key": { # Per-action challenge settings.
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"defaultSettings": { # Per-action challenge settings. # Required. Defines when a challenge is triggered (unless the default threshold is overridden for the given action, see `action_settings`).
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"integrationType": "A String", # Required. Describes how this key is integrated with the website.
},
}</pre>
</div>
<div class="method">
<code class="details" id="getMetrics">getMetrics(name, x__xgafv=None)</code>
<pre>Get some aggregated metrics for a Key. This data can be used to build dashboards.
Args:
name: string, Required. The name of the requested metrics, in the format `projects/{project}/keys/{key}/metrics`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Metrics for a single Key.
"challengeMetrics": [ # Metrics are continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have challenge-based data.
{ # Metrics related to challenges.
"failedCount": "A String", # Count of submitted challenge solutions that were incorrect or otherwise deemed suspicious such that a subsequent challenge was triggered.
"nocaptchaCount": "A String", # Count of nocaptchas (successful verification without a challenge) issued.
"pageloadCount": "A String", # Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to a count of pageloads for pages that include reCAPTCHA.
"passedCount": "A String", # Count of nocaptchas (successful verification without a challenge) plus submitted challenge solutions that were correct and resulted in verification.
},
],
"name": "A String", # Output only. Identifier. The name of the metrics, in the format `projects/{project}/keys/{key}/metrics`.
"scoreMetrics": [ # Metrics are continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.
{ # Metrics related to scoring.
"actionMetrics": { # Action-based metrics. The map key is the action name which specified by the site owners at time of the "execute" client-side call.
"a_key": { # Score distribution.
"scoreBuckets": { # Map key is score value multiplied by 100. The scores are discrete values between [0, 1]. The maximum number of buckets is on order of a few dozen, but typically much lower (ie. 10).
"a_key": "A String",
},
},
},
"overallMetrics": { # Score distribution. # Aggregated score metrics for all traffic.
"scoreBuckets": { # Map key is score value multiplied by 100. The scores are discrete values between [0, 1]. The maximum number of buckets is on order of a few dozen, but typically much lower (ie. 10).
"a_key": "A String",
},
},
},
],
"startTime": "A String", # Inclusive start time aligned to a day in the America/Los_Angeles (Pacific) timezone.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns the list of all keys that belong to a project.
Args:
parent: string, Required. The name of the project that contains the keys that is listed, in the format `projects/{project}`. (required)
pageSize: integer, Optional. The maximum number of keys to return. Default is 10. Max limit is 1000.
pageToken: string, Optional. The next_page_token value returned from a previous. ListKeysRequest, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to request to list keys in a project.
"keys": [ # Key details.
{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
"allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
"supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
},
"createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
"displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
"expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
},
"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
"allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
"appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
"keyId": "A String", # Required. The Apple developer key ID (10-character string).
"privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
},
},
"labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
"testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
},
"wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
"wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
"wafService": "A String", # Required. The WAF service that uses this key.
},
"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
"allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
"allowAmpTraffic": True or False, # Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
"allowedDomains": [ # Optional. Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
"A String",
],
"challengeSecurityPreference": "A String", # Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for `IntegrationType` CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.
"challengeSettings": { # Settings for POLICY_BASED_CHALLENGE keys to control when a challenge is triggered. # Optional. Challenge settings.
"actionSettings": { # Optional. The action to score threshold map. The action name should be the same as the action name passed in the `data-action` attribute (see https://cloud.google.com/recaptcha/docs/actions-website). Action names are case-insensitive. There is a maximum of 100 action settings. An action name has a maximum length of 100.
"a_key": { # Per-action challenge settings.
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"defaultSettings": { # Per-action challenge settings. # Required. Defines when a challenge is triggered (unless the default threshold is overridden for the given action, see `action_settings`).
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"integrationType": "A String", # Required. Describes how this key is integrated with the website.
},
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results. It is set to empty if no keys remain in results.
}</pre>
</div>
<div class="method">
<code class="details" id="listIpOverrides">listIpOverrides(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all IP overrides for a key.
Args:
parent: string, Required. The parent key for which the IP overrides are listed, in the format `projects/{project}/keys/{key}`. (required)
pageSize: integer, Optional. The maximum number of overrides to return. Default is 10. Max limit is 100. If the number of overrides is less than the page_size, all overrides are returned. If the page size is more than 100, it is coerced to 100.
pageToken: string, Optional. The next_page_token value returned from a previous ListIpOverridesRequest, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListIpOverrides.
"ipOverrides": [ # IP Overrides details.
{ # Information about the IP or IP range override.
"ip": "A String", # Required. The IP address to override (can be IPv4, IPv6 or CIDR). The IP override must be a valid IPv4 or IPv6 address, or a CIDR range. The IP override must be a public IP address. Example of IPv4: 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: 2001:0DB8:1234::/48
"overrideType": "A String", # Required. Describes the type of IP override.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results. If this field is empty, no keys remain in the results.
}</pre>
</div>
<div class="method">
<code class="details" id="listIpOverrides_next">listIpOverrides_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="migrate">migrate(name, body=None, x__xgafv=None)</code>
<pre>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.
Args:
name: string, Required. The name of the key to be migrated, in the format `projects/{project}/keys/{key}`. (required)
body: object, The request body.
The object takes the form of:
{ # The migrate key request message.
"skipBillingCheck": True or False, # 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/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/docs/billing-information.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
"allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
"supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
},
"createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
"displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
"expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
},
"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
"allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
"appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
"keyId": "A String", # Required. The Apple developer key ID (10-character string).
"privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
},
},
"labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
"testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
},
"wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
"wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
"wafService": "A String", # Required. The WAF service that uses this key.
},
"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
"allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
"allowAmpTraffic": True or False, # Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
"allowedDomains": [ # Optional. Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
"A String",
],
"challengeSecurityPreference": "A String", # Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for `IntegrationType` CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.
"challengeSettings": { # Settings for POLICY_BASED_CHALLENGE keys to control when a challenge is triggered. # Optional. Challenge settings.
"actionSettings": { # Optional. The action to score threshold map. The action name should be the same as the action name passed in the `data-action` attribute (see https://cloud.google.com/recaptcha/docs/actions-website). Action names are case-insensitive. There is a maximum of 100 action settings. An action name has a maximum length of 100.
"a_key": { # Per-action challenge settings.
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"defaultSettings": { # Per-action challenge settings. # Required. Defines when a challenge is triggered (unless the default threshold is overridden for the given action, see `action_settings`).
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"integrationType": "A String", # Required. Describes how this key is integrated with the website.
},
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the specified key.
Args:
name: string, Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. (required)
body: object, The request body.
The object takes the form of:
{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
"allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
"supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
},
"createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
"displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
"expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
},
"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
"allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
"appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
"keyId": "A String", # Required. The Apple developer key ID (10-character string).
"privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
},
},
"labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
"testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
},
"wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
"wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
"wafService": "A String", # Required. The WAF service that uses this key.
},
"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
"allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
"allowAmpTraffic": True or False, # Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
"allowedDomains": [ # Optional. Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
"A String",
],
"challengeSecurityPreference": "A String", # Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for `IntegrationType` CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.
"challengeSettings": { # Settings for POLICY_BASED_CHALLENGE keys to control when a challenge is triggered. # Optional. Challenge settings.
"actionSettings": { # Optional. The action to score threshold map. The action name should be the same as the action name passed in the `data-action` attribute (see https://cloud.google.com/recaptcha/docs/actions-website). Action names are case-insensitive. There is a maximum of 100 action settings. An action name has a maximum length of 100.
"a_key": { # Per-action challenge settings.
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"defaultSettings": { # Per-action challenge settings. # Required. Defines when a challenge is triggered (unless the default threshold is overridden for the given action, see `action_settings`).
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"integrationType": "A String", # Required. Describes how this key is integrated with the website.
},
}
updateMask: string, Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields are updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
"androidSettings": { # Settings specific to keys that can be used by Android apps. # Settings for keys that can be used by Android apps.
"allowAllPackageNames": True or False, # Optional. If set to true, allowed_package_names are not enforced.
"allowedPackageNames": [ # Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
"A String",
],
"supportNonGoogleAppStoreDistribution": True or False, # Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.
},
"createTime": "A String", # Output only. The timestamp corresponding to the creation of this key.
"displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user.
"expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express.
},
"iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps.
"allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced.
"allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
"A String",
],
"appleDeveloperId": { # Contains fields that are required to perform Apple-specific integrity checks. # Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.
"keyId": "A String", # Required. The Apple developer key ID (10-character string).
"privateKey": "A String", # Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.
"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.
},
},
"labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.
"testingOptions": { # Options for user acceptance testing. # Optional. Options for user acceptance testing.
"testingChallenge": "A String", # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.
"testingScore": 3.14, # Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
},
"wafSettings": { # Settings specific to keys that can be used for WAF (Web Application Firewall). # Optional. Settings for WAF
"wafFeature": "A String", # Required. The WAF feature for which this key is enabled.
"wafService": "A String", # Required. The WAF service that uses this key.
},
"webSettings": { # Settings specific to keys that can be used by websites. # Settings for keys that can be used by websites.
"allowAllDomains": True or False, # Optional. If set to true, it means allowed_domains are not enforced.
"allowAmpTraffic": True or False, # Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
"allowedDomains": [ # Optional. Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
"A String",
],
"challengeSecurityPreference": "A String", # Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for `IntegrationType` CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.
"challengeSettings": { # Settings for POLICY_BASED_CHALLENGE keys to control when a challenge is triggered. # Optional. Challenge settings.
"actionSettings": { # Optional. The action to score threshold map. The action name should be the same as the action name passed in the `data-action` attribute (see https://cloud.google.com/recaptcha/docs/actions-website). Action names are case-insensitive. There is a maximum of 100 action settings. An action name has a maximum length of 100.
"a_key": { # Per-action challenge settings.
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"defaultSettings": { # Per-action challenge settings. # Required. Defines when a challenge is triggered (unless the default threshold is overridden for the given action, see `action_settings`).
"scoreThreshold": 3.14, # Required. A challenge is triggered if the end-user score is below that threshold. Value must be between 0 and 1 (inclusive).
},
},
"integrationType": "A String", # Required. Describes how this key is integrated with the website.
},
}</pre>
</div>
<div class="method">
<code class="details" id="removeIpOverride">removeIpOverride(name, body=None, x__xgafv=None)</code>
<pre>Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a `NOT_FOUND` error is returned. * If the IP is found in an existing IP override, but the override type does not match, a `NOT_FOUND` error is returned.
Args:
name: string, Required. The name of the key from which the IP override is removed, in the format `projects/{project}/keys/{key}`. (required)
body: object, The request body.
The object takes the form of:
{ # The RemoveIpOverride request message.
"ipOverrideData": { # Information about the IP or IP range override. # Required. IP override to be removed from the key.
"ip": "A String", # Required. The IP address to override (can be IPv4, IPv6 or CIDR). The IP override must be a valid IPv4 or IPv6 address, or a CIDR range. The IP override must be a public IP address. Example of IPv4: 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: 2001:0DB8:1234::/48
"overrideType": "A String", # Required. Describes the type of IP override.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for RemoveIpOverride.
}</pre>
</div>
<div class="method">
<code class="details" id="retrieveLegacySecretKey">retrieveLegacySecretKey(x__xgafv=None)</code>
<pre>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.
Args:
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd party integration with legacy reCAPTCHA.
"legacySecretKey": "A String", # The secret key (also known as shared secret) authorizes communication between your application backend and the reCAPTCHA Enterprise server to create an assessment. The secret key needs to be kept safe for security purposes.
}</pre>
</div>
</body></html>
|
