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_androidmanagement1_cli/enterprises_enrollment-tokens-create/index.html
Sebastian Thiel 37ba635de2 Update documentation
2021-04-02 00:20:57 +08:00

460 lines
18 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Enrollment Tokens Create - Android Management v2.0.0+20210322</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 Management v2.0.0+20210322</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Enterprises</span>
<li class="toctree-l1 ">
<a class="" href="../enterprises_applications-get">Applications Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_devices-delete">Devices Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_devices-get">Devices Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_devices-issue-command">Devices Issue Command</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_devices-list">Devices List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_devices-operations-cancel">Devices Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_devices-operations-delete">Devices Operations Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_devices-operations-get">Devices Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_devices-operations-list">Devices Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_devices-patch">Devices Patch</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Enrollment Tokens Create</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-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_enrollment-tokens-delete">Enrollment Tokens Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_policies-delete">Policies Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_policies-get">Policies Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_policies-list">Policies List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_policies-patch">Policies Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_web-apps-create">Web Apps Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_web-apps-delete">Web Apps Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_web-apps-get">Web Apps Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_web-apps-list">Web Apps List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_web-apps-patch">Web Apps Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../enterprises_web-tokens-create">Web Tokens Create</a>
</li>
<span>Signup Urls</span>
<li class="toctree-l1 ">
<a class="" href="../signup-urls_create">Create</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>Enrollment Tokens Create</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/master/gen/androidmanagement1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Creates an enrollment token for a given enterprise.</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 &lt;scope&gt; enterprises enrollment-tokens-create ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;parent&gt;</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>EnrollmentToken:
additional-data: string
allow-personal-usage: string
duration: string
expiration-timestamp: string
name: string
one-time-only: boolean
policy-name: string
qr-code: string
user:
account-identifier: string
value: 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 . additional-data=voluptua.</code><ul>
<li>Optional, arbitrary data associated with the enrollment token. This could contain, for example, the ID of an org unit the device is assigned to after enrollment. After a device enrolls with the token, this data will be exposed in the enrollment_token_data field of the Device resource. The data must be 1024 characters or less; otherwise, the creation request will fail.</li>
</ul>
</li>
<li><code>allow-personal-usage=amet.</code><ul>
<li>Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.</li>
</ul>
</li>
<li><code>duration=ea</code><ul>
<li>The length of time the enrollment token is valid, ranging from 1 minute to 90 days. If not specified, the default duration is 1 hour.</li>
</ul>
</li>
<li><code>expiration-timestamp=sadipscing</code><ul>
<li>The expiration time of the token. This is a read-only field generated by the server.</li>
</ul>
</li>
<li><code>name=lorem</code><ul>
<li>The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.</li>
</ul>
</li>
<li><code>one-time-only=true</code><ul>
<li>Whether the enrollment token is for one time use only. If the flag is set to true, only one device can use it for registration.</li>
</ul>
</li>
<li><code>policy-name=no</code><ul>
<li>The name of the policy initially applied to the enrolled device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device’s user is applied. If user_name is also not specified, enterprises/{enterpriseId}/policies/default is applied by default. When updating this field, you can specify only the policyId as long as the policyId doesn’t contain any slashes. The rest of the policy name will be inferred.</li>
</ul>
</li>
<li><code>qr-code=est</code><ul>
<li>A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON.</li>
</ul>
</li>
<li>
<p><code>user account-identifier=at</code></p>
<ul>
<li>A unique identifier you create for this user, such as user342 or asset#44418. This field must be set when the user is created and can&#39;t be updated. This field must not contain personally identifiable information (PII). This identifier must be 1024 characters or less; otherwise, the update policy request will fail.</li>
</ul>
</li>
<li>
<p><code>.. value=sed</code></p>
<ul>
<li>The token value that&#39;s passed to the device and authorizes the device to enroll. This is a read-only field generated 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-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="../enterprises_enrollment-tokens-delete" class="btn btn-neutral float-right" title="Enrollment Tokens Delete"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../enterprises_devices-patch" class="btn btn-neutral" title="Devices Patch"><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="../enterprises_devices-patch" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../enterprises_enrollment-tokens-delete" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink