mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
389 lines
21 KiB
HTML
389 lines
21 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-firebaseappcheck1_beta-cli/projects_apps-recaptcha-config-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Apps Recaptcha Config Patch - Firebaseappcheck v5.0.4+20240226</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 = "Apps Recaptcha Config Patch";
|
|
var mkdocs_page_input_path = "projects_apps-recaptcha-config-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-firebaseappcheck1_beta-cli/projects_apps-recaptcha-config-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"> Firebaseappcheck v5.0.4+20240226
|
|
</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">Jwks</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../jwks_get/">Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Oauth Clients</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../oauth-clients_exchange-app-attest-assertion/">Exchange App Attest Assertion</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../oauth-clients_exchange-app-attest-attestation/">Exchange App Attest Attestation</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../oauth-clients_exchange-debug-token/">Exchange Debug Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../oauth-clients_generate-app-attest-challenge/">Generate App Attest Challenge</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_apps-app-attest-config-batch-get/">Apps App Attest Config Batch Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-app-attest-config-get/">Apps App Attest Config Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-app-attest-config-patch/">Apps App Attest Config Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-debug-tokens-create/">Apps Debug Tokens Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-debug-tokens-delete/">Apps Debug Tokens Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-debug-tokens-get/">Apps Debug Tokens Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-debug-tokens-list/">Apps Debug Tokens List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-debug-tokens-patch/">Apps Debug Tokens Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-device-check-config-batch-get/">Apps Device Check Config Batch Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-device-check-config-get/">Apps Device Check Config Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-device-check-config-patch/">Apps Device Check Config Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-exchange-app-attest-assertion/">Apps Exchange App Attest Assertion</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-exchange-app-attest-attestation/">Apps Exchange App Attest Attestation</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-exchange-custom-token/">Apps Exchange Custom Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-exchange-debug-token/">Apps Exchange Debug Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-exchange-device-check-token/">Apps Exchange Device Check Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-exchange-play-integrity-token/">Apps Exchange Play Integrity Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-exchange-recaptcha-enterprise-token/">Apps Exchange Recaptcha Enterprise Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-exchange-recaptcha-token/">Apps Exchange Recaptcha Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-exchange-recaptcha-v3-token/">Apps Exchange Recaptcha V3 Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-exchange-safety-net-token/">Apps Exchange Safety Net Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-generate-app-attest-challenge/">Apps Generate App Attest Challenge</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-generate-play-integrity-challenge/">Apps Generate Play Integrity Challenge</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-play-integrity-config-batch-get/">Apps Play Integrity Config Batch Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-play-integrity-config-get/">Apps Play Integrity Config Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-play-integrity-config-patch/">Apps Play Integrity Config Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-recaptcha-config-batch-get/">Apps Recaptcha Config Batch Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-recaptcha-config-get/">Apps Recaptcha Config Get</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Apps Recaptcha Config Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-recaptcha-enterprise-config-batch-get/">Apps Recaptcha Enterprise Config Batch Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-recaptcha-enterprise-config-get/">Apps Recaptcha Enterprise Config Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-recaptcha-enterprise-config-patch/">Apps Recaptcha Enterprise Config Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-recaptcha-v3-config-batch-get/">Apps Recaptcha V3 Config Batch Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-recaptcha-v3-config-get/">Apps Recaptcha V3 Config Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-recaptcha-v3-config-patch/">Apps Recaptcha V3 Config Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-safety-net-config-batch-get/">Apps Safety Net Config Batch Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-safety-net-config-get/">Apps Safety Net Config Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_apps-safety-net-config-patch/">Apps Safety Net Config Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_services-batch-update/">Services Batch Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_services-get/">Services Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_services-list/">Services List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_services-patch/">Services Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_services-resource-policies-batch-update/">Services Resource Policies Batch Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_services-resource-policies-create/">Services Resource Policies Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_services-resource-policies-delete/">Services Resource Policies Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_services-resource-policies-get/">Services Resource Policies Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_services-resource-policies-list/">Services Resource Policies List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_services-resource-policies-patch/">Services Resource Policies Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_verify-app-check-token/">Verify App Check Token</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="..">Firebaseappcheck v5.0.4+20240226</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>Apps Recaptcha Config Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/firebaseappcheck1_beta-cli/edit/master/docs/projects_apps-recaptcha-config-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 RecaptchaConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA tokens for App Check tokens. For security reasons, the <code>site_secret</code> field is never populated in the response.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
|
<ul>
|
|
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
|
<li><em>https://www.googleapis.com/auth/firebase</em></li>
|
|
</ul>
|
|
<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>firebaseappcheck1-beta --scope <scope> projects apps-recaptcha-config-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: <code>projects/{project_number}/apps/{app_id}/recaptchaConfig</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>GoogleFirebaseAppcheckV1betaRecaptchaConfig:
|
|
name: string
|
|
site-secret: string
|
|
site-secret-set: boolean
|
|
token-ttl: 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 . name=et</code><ul>
|
|
<li>Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: <code>projects/{project_number}/apps/{app_id}/recaptchaConfig</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>site-secret=voluptua.</code><ul>
|
|
<li>Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>site-secret-set=false</code><ul>
|
|
<li>Output only. Whether the <code>site_secret</code> field was previously set. Since we will never return the <code>site_secret</code> field, this field is the only way to find out whether it was previously set.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>token-ttl=diam</code><ul>
|
|
<li>Specifies the duration for which App Check tokens exchanged from reCAPTCHA tokens will be valid. If unset, a default value of 1 day is assumed. Must be between 30 minutes and 7 days, inclusive.</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>Required. A comma-separated list of names of fields in the RecaptchaConfig to update. Example: <code>site_secret</code>.</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_apps-recaptcha-config-get/" class="btn btn-neutral float-left" title="Apps Recaptcha Config Get"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_apps-recaptcha-enterprise-config-batch-get/" class="btn btn-neutral float-right" title="Apps Recaptcha Enterprise Config Batch Get">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/firebaseappcheck1_beta-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_apps-recaptcha-config-get/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_apps-recaptcha-enterprise-config-batch-get/" 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>
|