OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
37ba635de2b0340299e6a35431c2efd0ca3aa555
google-apis-rs/google_androidenterprise1_cli/entitlements_update/index.html
Sebastian Thiel 37ba635de2 Update documentation
2021-04-02 00:20:57 +08:00

755 lines
25 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>Update - Android Enterprise v2.0.0+20210324</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"> Android Enterprise v2.0.0+20210324</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Devices</span>
<li class="toctree-l1 ">
<a class="" href="../devices_force-report-upload">Force Report Upload</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_get-state">Get State</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_set-state">Set State</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_update">Update</a>
</li>
<span>Enterprises</span>
<li class="toctree-l1 ">
<a class="" href="../enterprises_acknowledge-notification-set">Acknowledge Notification Set</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_complete-signup">Complete Signup</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_create-web-token">Create Web Token</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_enroll">Enroll</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_generate-signup-url">Generate Signup Url</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_get-service-account">Get Service Account</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_get-store-layout">Get Store Layout</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_pull-notification-set">Pull Notification Set</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_send-test-push-notification">Send Test Push Notification</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_set-account">Set Account</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_set-store-layout">Set Store Layout</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_unenroll">Unenroll</a>
</li>
<span>Entitlements</span>
<li class="toctree-l1 ">
<a class="" href="../entitlements_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../entitlements_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../entitlements_list">List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Update</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-arguments">Required Scalar Arguments</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>
<span>Grouplicenses</span>
<li class="toctree-l1 ">
<a class="" href="../grouplicenses_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../grouplicenses_list">List</a>
</li>
<span>Grouplicenseusers</span>
<li class="toctree-l1 ">
<a class="" href="../grouplicenseusers_list">List</a>
</li>
<span>Installs</span>
<li class="toctree-l1 ">
<a class="" href="../installs_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../installs_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../installs_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../installs_update">Update</a>
</li>
<span>Managedconfigurationsfordevice</span>
<li class="toctree-l1 ">
<a class="" href="../managedconfigurationsfordevice_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../managedconfigurationsfordevice_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../managedconfigurationsfordevice_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../managedconfigurationsfordevice_update">Update</a>
</li>
<span>Managedconfigurationsforuser</span>
<li class="toctree-l1 ">
<a class="" href="../managedconfigurationsforuser_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../managedconfigurationsforuser_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../managedconfigurationsforuser_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../managedconfigurationsforuser_update">Update</a>
</li>
<span>Managedconfigurationssettings</span>
<li class="toctree-l1 ">
<a class="" href="../managedconfigurationssettings_list">List</a>
</li>
<span>Permissions</span>
<li class="toctree-l1 ">
<a class="" href="../permissions_get">Get</a>
</li>
<span>Products</span>
<li class="toctree-l1 ">
<a class="" href="../products_approve">Approve</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../products_generate-approval-url">Generate Approval Url</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../products_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../products_get-app-restrictions-schema">Get App Restrictions Schema</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../products_get-permissions">Get Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../products_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../products_unapprove">Unapprove</a>
</li>
<span>Serviceaccountkeys</span>
<li class="toctree-l1 ">
<a class="" href="../serviceaccountkeys_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../serviceaccountkeys_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../serviceaccountkeys_list">List</a>
</li>
<span>Storelayoutclusters</span>
<li class="toctree-l1 ">
<a class="" href="../storelayoutclusters_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../storelayoutclusters_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../storelayoutclusters_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../storelayoutclusters_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../storelayoutclusters_update">Update</a>
</li>
<span>Storelayoutpages</span>
<li class="toctree-l1 ">
<a class="" href="../storelayoutpages_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../storelayoutpages_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../storelayoutpages_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../storelayoutpages_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../storelayoutpages_update">Update</a>
</li>
<span>Users</span>
<li class="toctree-l1 ">
<a class="" href="../users_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_generate-authentication-token">Generate Authentication Token</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_get-available-product-set">Get Available Product Set</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_revoke-device-access">Revoke Device Access</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_set-available-product-set">Set Available Product Set</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_update">Update</a>
</li>
<span>Webapps</span>
<li class="toctree-l1 ">
<a class="" href="../webapps_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../webapps_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../webapps_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../webapps_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../webapps_update">Update</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>Update</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/master/gen/androidenterprise1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Adds or updates an entitlement to an app for a user.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/androidenterprise</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/androidenterprise</em>.
You can set the scope for this method like this: <code>androidenterprise1 --scope &lt;scope&gt; entitlements update ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;enterprise-id&gt;</strong> <em>(string)</em><ul>
<li>The ID of the enterprise.</li>
</ul>
</li>
<li><strong>&lt;user-id&gt;</strong> <em>(string)</em><ul>
<li>The ID of the user.</li>
</ul>
</li>
<li><strong>&lt;entitlement-id&gt;</strong> <em>(string)</em><ul>
<li>The ID of the entitlement (a product ID), e.g. &#34;app:com.google.android.gm&#34;.</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>Entitlement:
product-id: string
reason: 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 . product-id=gubergren</code><ul>
<li>The ID of the product that the entitlement is for. For example, &#34;app:com.google.android.gm&#34;.</li>
</ul>
</li>
<li><code>reason=rebum.</code><ul>
<li>The reason for the entitlement. For example, &#34;free&#34; for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.</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 install=boolean</strong><ul>
<li>Set to true to also install the product on all the user&#39;s devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.</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="../grouplicenses_get" class="btn btn-neutral float-right" title="Get"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../entitlements_list" class="btn btn-neutral" title="List"><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="../entitlements_list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../grouplicenses_get" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink