OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-26 19:58:50 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_firebaseappcheck1_beta_cli/projects_apps-safety-net-config-patch/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

462 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Apps Safety Net Config Patch - Firebaseappcheck v3.0.0+20220225</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</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-nav-search">
<a href=".." class="icon icon-home"> Firebaseappcheck v3.0.0+20220225</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Jwks</span>
<li class="toctree-l1 ">
<a class="" href="../jwks_get">Get</a>
</li>
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-app-attest-config-batch-get">Apps App Attest Config Batch Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-app-attest-config-get">Apps App Attest Config Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-app-attest-config-patch">Apps App Attest Config Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-debug-tokens-create">Apps Debug Tokens Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-debug-tokens-delete">Apps Debug Tokens Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-debug-tokens-get">Apps Debug Tokens Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-debug-tokens-list">Apps Debug Tokens List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-debug-tokens-patch">Apps Debug Tokens Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-device-check-config-batch-get">Apps Device Check Config Batch Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-device-check-config-get">Apps Device Check Config Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-device-check-config-patch">Apps Device Check Config Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-exchange-app-attest-assertion">Apps Exchange App Attest Assertion</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-exchange-app-attest-attestation">Apps Exchange App Attest Attestation</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-exchange-custom-token">Apps Exchange Custom Token</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-exchange-debug-token">Apps Exchange Debug Token</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-exchange-device-check-token">Apps Exchange Device Check Token</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-exchange-recaptcha-enterprise-token">Apps Exchange Recaptcha Enterprise Token</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-exchange-recaptcha-token">Apps Exchange Recaptcha Token</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-exchange-safety-net-token">Apps Exchange Safety Net Token</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-generate-app-attest-challenge">Apps Generate App Attest Challenge</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-recaptcha-config-batch-get">Apps Recaptcha Config Batch Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-recaptcha-config-get">Apps Recaptcha Config Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-recaptcha-config-patch">Apps Recaptcha Config Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-recaptcha-enterprise-config-batch-get">Apps Recaptcha Enterprise Config Batch Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-recaptcha-enterprise-config-get">Apps Recaptcha Enterprise Config Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-recaptcha-enterprise-config-patch">Apps Recaptcha Enterprise Config Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-safety-net-config-batch-get">Apps Safety Net Config Batch Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_apps-safety-net-config-get">Apps Safety Net Config Get</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Apps Safety Net Config Patch</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_services-batch-update">Services Batch Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_services-get">Services Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_services-list">Services List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_services-patch">Services Patch</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></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="..">Docs</a> &raquo;</li>
<li>Apps Safety Net Config Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/firebaseappcheck1_beta-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Updates the SafetyNetConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange SafetyNet tokens for App Check tokens.</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 &lt;scope&gt; projects apps-safety-net-config-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>Required. The relative resource name of the SafetyNet configuration object, in the format: <code>projects/{project_number}/apps/{app_id}/safetyNetConfig</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>GoogleFirebaseAppcheckV1betaSafetyNetConfig:
name: string
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=ea</code><ul>
<li>Required. The relative resource name of the SafetyNet configuration object, in the format: <code>projects/{project_number}/apps/{app_id}/safetyNetConfig</code></li>
</ul>
</li>
<li><code>token-ttl=dolor</code><ul>
<li>Specifies the duration for which App Check tokens exchanged from SafetyNet tokens will be valid. If unset, a default value of 1 hour 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 SafetyNetConfig Gets to update. Example: <code>token_ttl</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. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../projects_services-batch-update" class="btn btn-neutral float-right" title="Services Batch Update"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_apps-safety-net-config-get" class="btn btn-neutral" title="Apps Safety Net Config Get"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/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" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../projects_apps-safety-net-config-get" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_services-batch-update" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink