docs/dyn/androidenterprise_v1.enrollmentTokens.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.enrollmentTokens.html">enrollmentTokens</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(enterpriseId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(enterpriseId, body=None, x__xgafv=None)</code>
  <pre>Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.

Args:
  enterpriseId: string, Required. The ID of the enterprise. (required)
  body: object, The request body.
    The object takes the form of:

{ # A token used to enroll a device.
  &quot;duration&quot;: &quot;A String&quot;, # [Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour. In the JSON REST API, this is represented as a string (e.g., `3600s`).
  &quot;enrollmentTokenType&quot;: &quot;A String&quot;, # [Required] The type of the enrollment token.
  &quot;googleAuthenticationOptions&quot;: { # Options for Google authentication during the enrollment. # [Optional] Provides options related to Google authentication during the enrollment.
    &quot;authenticationRequirement&quot;: &quot;A String&quot;, # [Optional] Specifies whether user should authenticate with Google during enrollment. This setting, if specified,`GoogleAuthenticationSettings` specified for the enterprise resource is ignored for devices enrolled with this token.
    &quot;requiredAccountEmail&quot;: &quot;A String&quot;, # [Optional] Specifies the managed Google account that the user must use during enrollment.`AuthenticationRequirement` must be set to`REQUIRED` if this field is set.
  },
  &quot;token&quot;: &quot;A String&quot;, # The token value that&#x27;s passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A token used to enroll a device.
  &quot;duration&quot;: &quot;A String&quot;, # [Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour. In the JSON REST API, this is represented as a string (e.g., `3600s`).
  &quot;enrollmentTokenType&quot;: &quot;A String&quot;, # [Required] The type of the enrollment token.
  &quot;googleAuthenticationOptions&quot;: { # Options for Google authentication during the enrollment. # [Optional] Provides options related to Google authentication during the enrollment.
    &quot;authenticationRequirement&quot;: &quot;A String&quot;, # [Optional] Specifies whether user should authenticate with Google during enrollment. This setting, if specified,`GoogleAuthenticationSettings` specified for the enterprise resource is ignored for devices enrolled with this token.
    &quot;requiredAccountEmail&quot;: &quot;A String&quot;, # [Optional] Specifies the managed Google account that the user must use during enrollment.`AuthenticationRequirement` must be set to`REQUIRED` if this field is set.
  },
  &quot;token&quot;: &quot;A String&quot;, # The token value that&#x27;s passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
}</pre>
</div>

</body></html>