mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 21:02:29 +01:00
362 lines
17 KiB
HTML
362 lines
17 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-androiddeviceprovisioning1-cli/customers_configurations-patch/" />
|
||
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||
<title>Configurations Patch - Android Provisioning Partner v5.0.4+20240304</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 = "Configurations Patch";
|
||
var mkdocs_page_input_path = "customers_configurations-patch.md";
|
||
var mkdocs_page_url = "/google-apis-rs/google-androiddeviceprovisioning1-cli/customers_configurations-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"> Android Provisioning Partner v5.0.4+20240304
|
||
</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">Customers</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../customers_configurations-create/">Configurations Create</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../customers_configurations-delete/">Configurations Delete</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../customers_configurations-get/">Configurations Get</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../customers_configurations-list/">Configurations List</a>
|
||
</li>
|
||
<li class="toctree-l1 current"><a class="reference internal current" href="./">Configurations Patch</a>
|
||
<ul class="current">
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-apply-configuration/">Devices Apply Configuration</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-get/">Devices Get</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-list/">Devices List</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-remove-configuration/">Devices Remove Configuration</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-unclaim/">Devices Unclaim</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../customers_dpcs-list/">Dpcs List</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../customers_list/">List</a>
|
||
</li>
|
||
</ul>
|
||
<p class="caption"><span class="caption-text">Operations</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
|
||
</li>
|
||
</ul>
|
||
<p class="caption"><span class="caption-text">Partners</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_customers-create/">Customers Create</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_customers-list/">Customers List</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_devices-claim/">Devices Claim</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_devices-claim-async/">Devices Claim Async</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_devices-find-by-identifier/">Devices Find By Identifier</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_devices-find-by-owner/">Devices Find By Owner</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_devices-get/">Devices Get</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_devices-get-sim-lock-state/">Devices Get Sim Lock State</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_devices-metadata/">Devices Metadata</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_devices-unclaim/">Devices Unclaim</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_devices-unclaim-async/">Devices Unclaim Async</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_devices-update-metadata-async/">Devices Update Metadata Async</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_vendors-customers-list/">Vendors Customers List</a>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../partners_vendors-list/">Vendors 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="..">Android Provisioning Partner v5.0.4+20240304</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>Customers »</li>
|
||
<li>Configurations Patch</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/androiddeviceprovisioning1-cli/edit/master/docs/customers_configurations-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 a configuration's field values.</p>
|
||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||
<ul>
|
||
<li><strong><name></strong> <em>(string)</em><ul>
|
||
<li>Output only. The API resource name in the format <code>customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]</code>. Assigned by the server.</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>Configuration:
|
||
company-name: string
|
||
configuration-id: string
|
||
configuration-name: string
|
||
contact-email: string
|
||
contact-phone: string
|
||
custom-message: string
|
||
dpc-extras: string
|
||
dpc-resource-path: string
|
||
forced-reset-time: string
|
||
is-default: boolean
|
||
name: 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 . company-name=duo</code><ul>
|
||
<li>Required. The name of the organization. Zero-touch enrollment shows this organization name to device users during device provisioning.</li>
|
||
</ul>
|
||
</li>
|
||
<li><code>configuration-id=ipsum</code><ul>
|
||
<li>Output only. The ID of the configuration. Assigned by the server.</li>
|
||
</ul>
|
||
</li>
|
||
<li><code>configuration-name=gubergren</code><ul>
|
||
<li>Required. A short name that describes the configuration's purpose. For example, <em>Sales team</em> or <em>Temporary employees</em>. The zero-touch enrollment portal displays this name to IT admins.</li>
|
||
</ul>
|
||
</li>
|
||
<li><code>contact-email=lorem</code><ul>
|
||
<li>Required. The email address that device users can contact to get help. Zero-touch enrollment shows this email address to device users before device provisioning. The value is validated on input.</li>
|
||
</ul>
|
||
</li>
|
||
<li><code>contact-phone=gubergren</code><ul>
|
||
<li>Required. The telephone number that device users can call, using another device, to get help. Zero-touch enrollment shows this number to device users before device provisioning. Accepts numerals, spaces, the plus sign, hyphens, and parentheses.</li>
|
||
</ul>
|
||
</li>
|
||
<li><code>custom-message=eos</code><ul>
|
||
<li>A message, containing one or two sentences, to help device users get help or give them more details about what’s happening to their device. Zero-touch enrollment shows this message before the device is provisioned.</li>
|
||
</ul>
|
||
</li>
|
||
<li><code>dpc-extras=dolor</code><ul>
|
||
<li>The JSON-formatted EMM provisioning extras that are passed to the DPC.</li>
|
||
</ul>
|
||
</li>
|
||
<li><code>dpc-resource-path=ea</code><ul>
|
||
<li>Required. The resource name of the selected DPC (device policy controller) in the format <code>customers/[CUSTOMER_ID]/dpcs/*</code>. To list the supported DPCs, call <code>customers.dpcs.list</code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><code>forced-reset-time=ipsum</code><ul>
|
||
<li>Optional. The timeout before forcing factory reset the device if the device doesn't go through provisioning in the setup wizard, usually due to lack of network connectivity during setup wizard. Ranges from 0-6 hours, with 2 hours being the default if unset.</li>
|
||
</ul>
|
||
</li>
|
||
<li><code>is-default=false</code><ul>
|
||
<li>Required. Whether this is the default configuration that zero-touch enrollment applies to any new devices the organization purchases in the future. Only one customer configuration can be the default. Setting this value to <code>true</code>, changes the previous default configuration's <code>isDefault</code> value to <code>false</code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li><code>name=amet</code><ul>
|
||
<li>Output only. The API resource name in the format <code>customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]</code>. Assigned by the server.</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. The field mask applied to the target <code>Configuration</code> before updating the fields. To learn more about using field masks, read <a href="/protocol-buffers/docs/reference/google.protobuf#fieldmask">FieldMask</a> in the Protocol Buffers documentation.</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="../customers_configurations-list/" class="btn btn-neutral float-left" title="Configurations List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||
<a href="../customers_devices-apply-configuration/" class="btn btn-neutral float-right" title="Devices Apply Configuration">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/androiddeviceprovisioning1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
||
</span>
|
||
|
||
|
||
<span><a href="../customers_configurations-list/" style="color: #fcfcfc">« Previous</a></span>
|
||
|
||
|
||
<span><a href="../customers_devices-apply-configuration/" 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>
|