Skip to content

Commit 0e18da8

Browse files
feat(recaptchaenterprise): update the api
#### recaptchaenterprise:v1 The following keys were added: - resources.projects.resources.keys.methods.addIpOverride (Total Keys: 12) - schemas.GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest (Total Keys: 3) - schemas.GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse (Total Keys: 2) - schemas.GoogleCloudRecaptchaenterpriseV1IpOverrideData (Total Keys: 4)
1 parent b1c1442 commit 0e18da8

File tree

2 files changed

+100
-1
lines changed

2 files changed

+100
-1
lines changed

docs/dyn/recaptchaenterprise_v1.projects.keys.html

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@
7474

7575
<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>
7676
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#addIpOverride">addIpOverride(name, body=None, x__xgafv=None)</a></code></p>
79+
<p class="firstline">Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error will be returned.</p>
7780
<p class="toc_element">
7881
<code><a href="#close">close()</a></code></p>
7982
<p class="firstline">Close httplib2 connections.</p>
@@ -105,6 +108,34 @@ <h2>Instance Methods</h2>
105108
<code><a href="#retrieveLegacySecretKey">retrieveLegacySecretKey(x__xgafv=None)</a></code></p>
106109
<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>
107110
<h3>Method Details</h3>
111+
<div class="method">
112+
<code class="details" id="addIpOverride">addIpOverride(name, body=None, x__xgafv=None)</code>
113+
<pre>Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error will be returned.
114+
115+
Args:
116+
name: string, Required. The name of the key to which the IP override is added, in the format `projects/{project}/keys/{key}`. (required)
117+
body: object, The request body.
118+
The object takes the form of:
119+
120+
{ # The AddIpOverride request message.
121+
&quot;ipOverrideData&quot;: { # Information about the IP or IP range override. # Required. IP override added to the key.
122+
&quot;ip&quot;: &quot;A String&quot;, # 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
123+
&quot;overrideType&quot;: &quot;A String&quot;, # Required. Describes the type of IP override.
124+
},
125+
}
126+
127+
x__xgafv: string, V1 error format.
128+
Allowed values
129+
1 - v1 error format
130+
2 - v2 error format
131+
132+
Returns:
133+
An object of the form:
134+
135+
{ # Response for AddIpOverride.
136+
}</pre>
137+
</div>
138+
108139
<div class="method">
109140
<code class="details" id="close">close()</code>
110141
<pre>Close httplib2 connections.</pre>

googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,34 @@
349349
},
350350
"keys": {
351351
"methods": {
352+
"addIpOverride": {
353+
"description": "Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error will be returned.",
354+
"flatPath": "v1/projects/{projectsId}/keys/{keysId}:addIpOverride",
355+
"httpMethod": "POST",
356+
"id": "recaptchaenterprise.projects.keys.addIpOverride",
357+
"parameterOrder": [
358+
"name"
359+
],
360+
"parameters": {
361+
"name": {
362+
"description": "Required. The name of the key to which the IP override is added, in the format `projects/{project}/keys/{key}`.",
363+
"location": "path",
364+
"pattern": "^projects/[^/]+/keys/[^/]+$",
365+
"required": true,
366+
"type": "string"
367+
}
368+
},
369+
"path": "v1/{+name}:addIpOverride",
370+
"request": {
371+
"$ref": "GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest"
372+
},
373+
"response": {
374+
"$ref": "GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse"
375+
},
376+
"scopes": [
377+
"https://www.googleapis.com/auth/cloud-platform"
378+
]
379+
},
352380
"create": {
353381
"description": "Creates a new reCAPTCHA Enterprise key.",
354382
"flatPath": "v1/projects/{projectsId}/keys",
@@ -694,7 +722,7 @@
694722
}
695723
}
696724
},
697-
"revision": "20240713",
725+
"revision": "20240721",
698726
"rootUrl": "https://recaptchaenterprise.googleapis.com/",
699727
"schemas": {
700728
"GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": {
@@ -778,6 +806,23 @@
778806
},
779807
"type": "object"
780808
},
809+
"GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest": {
810+
"description": "The AddIpOverride request message.",
811+
"id": "GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest",
812+
"properties": {
813+
"ipOverrideData": {
814+
"$ref": "GoogleCloudRecaptchaenterpriseV1IpOverrideData",
815+
"description": "Required. IP override added to the key."
816+
}
817+
},
818+
"type": "object"
819+
},
820+
"GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse": {
821+
"description": "Response for AddIpOverride.",
822+
"id": "GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse",
823+
"properties": {},
824+
"type": "object"
825+
},
781826
"GoogleCloudRecaptchaenterpriseV1AndroidKeySettings": {
782827
"description": "Settings specific to keys that can be used by Android apps.",
783828
"id": "GoogleCloudRecaptchaenterpriseV1AndroidKeySettings",
@@ -1391,6 +1436,29 @@ true
13911436
},
13921437
"type": "object"
13931438
},
1439+
"GoogleCloudRecaptchaenterpriseV1IpOverrideData": {
1440+
"description": "Information about the IP or IP range override.",
1441+
"id": "GoogleCloudRecaptchaenterpriseV1IpOverrideData",
1442+
"properties": {
1443+
"ip": {
1444+
"description": "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",
1445+
"type": "string"
1446+
},
1447+
"overrideType": {
1448+
"description": "Required. Describes the type of IP override.",
1449+
"enum": [
1450+
"OVERRIDE_TYPE_UNSPECIFIED",
1451+
"ALLOW"
1452+
],
1453+
"enumDescriptions": [
1454+
"Default override type that indicates this enum hasn't been specified.",
1455+
"Allowlist the IP address; i.e. give a `risk_analysis.score` of 0.9 for all valid assessments."
1456+
],
1457+
"type": "string"
1458+
}
1459+
},
1460+
"type": "object"
1461+
},
13941462
"GoogleCloudRecaptchaenterpriseV1Key": {
13951463
"description": "A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.",
13961464
"id": "GoogleCloudRecaptchaenterpriseV1Key",

0 commit comments

Comments
 (0)