mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
420 lines
18 KiB
HTML
420 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-recaptchaenterprise1-cli/projects_keys-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Keys Patch - Recaptcha Enterprise v5.0.4+20240303</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Keys Patch";
|
|
var mkdocs_page_input_path = "projects_keys-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-recaptchaenterprise1-cli/projects_keys-patch/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Recaptcha Enterprise v5.0.4+20240303
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_assessments-annotate/">Assessments Annotate</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_assessments-create/">Assessments Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_firewallpolicies-create/">Firewallpolicies Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_firewallpolicies-delete/">Firewallpolicies Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_firewallpolicies-get/">Firewallpolicies Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_firewallpolicies-list/">Firewallpolicies List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_firewallpolicies-patch/">Firewallpolicies Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_firewallpolicies-reorder/">Firewallpolicies Reorder</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_keys-create/">Keys Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_keys-delete/">Keys Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_keys-get/">Keys Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_keys-get-metrics/">Keys Get Metrics</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_keys-list/">Keys List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_keys-migrate/">Keys Migrate</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Keys Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_keys-retrieve-legacy-secret-key/">Keys Retrieve Legacy Secret Key</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_relatedaccountgroupmemberships-search/">Relatedaccountgroupmemberships Search</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_relatedaccountgroups-list/">Relatedaccountgroups List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_relatedaccountgroups-memberships-list/">Relatedaccountgroups Memberships List</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Recaptcha Enterprise v5.0.4+20240303</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Projects »</li>
|
|
<li>Keys Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/recaptchaenterprise1-cli/edit/master/docs/projects_keys-patch.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Updates the specified key.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
|
You can set the scope for this method like this: <code>recaptchaenterprise1 --scope <scope> projects keys-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Identifier. The resource name for the Key in the format <code>projects/{project}/keys/{key}</code>.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>GoogleCloudRecaptchaenterpriseV1Key:
|
|
android-settings:
|
|
allow-all-package-names: boolean
|
|
allowed-package-names: [string]
|
|
support-non-google-app-store-distribution: boolean
|
|
create-time: string
|
|
display-name: string
|
|
ios-settings:
|
|
allow-all-bundle-ids: boolean
|
|
allowed-bundle-ids: [string]
|
|
apple-developer-id:
|
|
key-id: string
|
|
private-key: string
|
|
team-id: string
|
|
labels: { string: string }
|
|
name: string
|
|
testing-options:
|
|
testing-challenge: string
|
|
testing-score: number
|
|
waf-settings:
|
|
waf-feature: string
|
|
waf-service: string
|
|
web-settings:
|
|
allow-all-domains: boolean
|
|
allow-amp-traffic: boolean
|
|
allowed-domains: [string]
|
|
challenge-security-preference: string
|
|
integration-type: string
|
|
|
|
</code></pre>
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r .android-settings allow-all-package-names=false</code><ul>
|
|
<li>Optional. If set to true, allowed_package_names are not enforced.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>allowed-package-names=erat</code><ul>
|
|
<li>Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>support-non-google-app-store-distribution=false</code></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. create-time=amet</code></p>
|
|
<ul>
|
|
<li>Output only. The timestamp corresponding to the creation of this key.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>display-name=est</code><ul>
|
|
<li>Required. Human-readable display name of this key. Modifiable by user.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ios-settings allow-all-bundle-ids=false</code><ul>
|
|
<li>Optional. If set to true, allowed_bundle_ids are not enforced.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>allowed-bundle-ids=consetetur</code><ul>
|
|
<li>Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>apple-developer-id key-id=stet</code><ul>
|
|
<li>Required. The Apple developer key ID (10-character string).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>private-key=est</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>team-id=aliquyam</code></p>
|
|
<ul>
|
|
<li>Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... labels=key=elitr</code></p>
|
|
<ul>
|
|
<li>Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels).</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=duo</code><ul>
|
|
<li>Identifier. The resource name for the Key in the format <code>projects/{project}/keys/{key}</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>testing-options testing-challenge=diam</code><ul>
|
|
<li>Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>testing-score=0.3473002864453434</code></p>
|
|
<ul>
|
|
<li>Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..waf-settings waf-feature=sed</code></p>
|
|
<ul>
|
|
<li>Required. The WAF feature for which this key is enabled.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>waf-service=eos</code></p>
|
|
<ul>
|
|
<li>Required. The WAF service that uses this key.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..web-settings allow-all-domains=true</code></p>
|
|
<ul>
|
|
<li>Optional. If set to true, it means allowed_domains will not be enforced.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>allow-amp-traffic=true</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>allowed-domains=sea</code><ul>
|
|
<li>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'</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>challenge-security-preference=et</code><ul>
|
|
<li>Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>integration-type=at</code><ul>
|
|
<li>Required. Describes how this key is integrated with the website.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li><strong>-p update-mask=string</strong><ul>
|
|
<li>Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields will be updated.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../projects_keys-migrate/" class="btn btn-neutral float-left" title="Keys Migrate"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_keys-retrieve-legacy-secret-key/" class="btn btn-neutral float-right" title="Keys Retrieve Legacy Secret Key">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/recaptchaenterprise1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_keys-migrate/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_keys-retrieve-legacy-secret-key/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|