mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
409 lines
18 KiB
HTML
409 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-androidmanagement1-cli/enterprises_patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Patch - Android Management v5.0.4+20240221</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 = "Patch";
|
|
var mkdocs_page_input_path = "enterprises_patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-androidmanagement1-cli/enterprises_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 Management v5.0.4+20240221
|
|
</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">Enterprises</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_applications-get/">Applications Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-delete/">Devices Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-get/">Devices Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-issue-command/">Devices Issue Command</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-list/">Devices List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-operations-cancel/">Devices Operations Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-operations-get/">Devices Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-operations-list/">Devices Operations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-patch/">Devices Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_enrollment-tokens-create/">Enrollment Tokens Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_enrollment-tokens-delete/">Enrollment Tokens Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_enrollment-tokens-get/">Enrollment Tokens Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_enrollment-tokens-list/">Enrollment Tokens List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_migration-tokens-create/">Migration Tokens Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_migration-tokens-get/">Migration Tokens Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_migration-tokens-list/">Migration Tokens List</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_policies-delete/">Policies Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_policies-get/">Policies Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_policies-list/">Policies List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_policies-patch/">Policies Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_web-apps-create/">Web Apps Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_web-apps-delete/">Web Apps Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_web-apps-get/">Web Apps Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_web-apps-list/">Web Apps List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_web-apps-patch/">Web Apps Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_web-tokens-create/">Web Tokens Create</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Provisioning Info</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../provisioning-info_get/">Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Signup Urls</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../signup-urls_create/">Create</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 Management v5.0.4+20240221</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>Enterprises »</li>
|
|
<li>Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/androidmanagement1-cli/edit/master/docs/enterprises_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 an enterprise. See also: SigninDetail</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/androidmanagement</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/androidmanagement</em>.
|
|
You can set the scope for this method like this: <code>androidmanagement1 --scope <scope> enterprises patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>The name of the enterprise in the form enterprises/{enterpriseId}.</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>Enterprise:
|
|
app-auto-approval-enabled: boolean
|
|
contact-info:
|
|
contact-email: string
|
|
data-protection-officer-email: string
|
|
data-protection-officer-name: string
|
|
data-protection-officer-phone: string
|
|
eu-representative-email: string
|
|
eu-representative-name: string
|
|
eu-representative-phone: string
|
|
enabled-notification-types: [string]
|
|
enterprise-display-name: string
|
|
logo:
|
|
sha256-hash: string
|
|
url: string
|
|
name: string
|
|
primary-color: integer
|
|
pubsub-topic: 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 . app-auto-approval-enabled=true</code><ul>
|
|
<li>Deprecated and unused.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>contact-info contact-email=est</code><ul>
|
|
<li>Email address for a point of contact, which will be used to send important announcements related to managed Google Play.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>data-protection-officer-email=aliquyam</code><ul>
|
|
<li>The email of the data protection officer. The email is validated but not verified.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>data-protection-officer-name=elitr</code><ul>
|
|
<li>The name of the data protection officer.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>data-protection-officer-phone=duo</code><ul>
|
|
<li>The phone number of the data protection officer The phone number is validated but not verified.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>eu-representative-email=diam</code><ul>
|
|
<li>The email of the EU representative. The email is validated but not verified.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>eu-representative-name=est</code><ul>
|
|
<li>The name of the EU representative.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>eu-representative-phone=sit</code></p>
|
|
<ul>
|
|
<li>The phone number of the EU representative. The phone number is validated but not verified.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. enabled-notification-types=sed</code></p>
|
|
<ul>
|
|
<li>The types of Google Pub/Sub notifications enabled for the enterprise.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>enterprise-display-name=eos</code><ul>
|
|
<li>The name of the enterprise displayed to users. This field has a maximum length of 100 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>logo sha256-hash=lorem</code><ul>
|
|
<li>The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>url=ea</code></p>
|
|
<ul>
|
|
<li>The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn't provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. name=stet</code></p>
|
|
<ul>
|
|
<li>The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>primary-color=82</code><ul>
|
|
<li>A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>pubsub-topic=eos</code><ul>
|
|
<li>The topic which Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.</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>The field mask indicating the fields to update. If not set, all modifiable fields will be modified.</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="../enterprises_migration-tokens-list/" class="btn btn-neutral float-left" title="Migration Tokens List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../enterprises_policies-delete/" class="btn btn-neutral float-right" title="Policies Delete">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/androidmanagement1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../enterprises_migration-tokens-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../enterprises_policies-delete/" 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>
|