Skip to content

Commit

Permalink
feat(androidenterprise): update the api
Browse files Browse the repository at this point in the history
#### androidenterprise:v1

The following keys were added:
- resources.enterprises.methods.createEnrollmentToken (Total Keys: 12)
- schemas.CreateEnrollmentTokenResponse (Total Keys: 3)
  • Loading branch information
yoshi-automation committed Dec 20, 2022
1 parent 6057d89 commit ec22103
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 3 deletions.
29 changes: 28 additions & 1 deletion docs/dyn/androidenterprise_v1.enterprises.html
Expand Up @@ -83,6 +83,9 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#completeSignup">completeSignup(completionToken=None, enterpriseToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.</p>
<p class="toc_element">
<code><a href="#createEnrollmentToken">createEnrollmentToken(enterpriseId, deviceType=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>
<p class="toc_element">
<code><a href="#createWebToken">createWebToken(enterpriseId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.</p>
Expand Down Expand Up @@ -165,6 +168,30 @@ <h3>Method Details</h3>
}</pre>
</div>

<div class="method">
<code class="details" id="createEnrollmentToken">createEnrollmentToken(enterpriseId, deviceType=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, The ID of the enterprise. (required)
deviceType: string, Whether it鈥檚 a dedicated device or a knowledge worker device.
Allowed values
unknown - This value is unused
dedicatedDevice - This device is a dedicated device.
knowledgeWorker - This device is required to have an authenticated user.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response message for create enrollment token.
&quot;enrollmentToken&quot;: &quot;A String&quot;, # Enrollment token.
}</pre>
</div>

<div class="method">
<code class="details" id="createWebToken">createWebToken(enterpriseId, body=None, x__xgafv=None)</code>
<pre>Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.
Expand Down Expand Up @@ -384,7 +411,7 @@ <h3>Method Details</h3>
<pre>Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.

Args:
requestMode: string, The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
requestMode: string, The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Specifying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
Allowed values
waitForNotifications - Wait until one or more notifications are present.
returnImmediately - Returns immediately whether notifications are present or not.
Expand Down
Expand Up @@ -383,6 +383,45 @@
"https://www.googleapis.com/auth/androidenterprise"
]
},
"createEnrollmentToken": {
"description": "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.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/createEnrollmentToken",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.createEnrollmentToken",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"deviceType": {
"description": "Whether it\u2019s a dedicated device or a knowledge worker device.",
"enum": [
"unknown",
"dedicatedDevice",
"knowledgeWorker"
],
"enumDescriptions": [
"This value is unused",
"This device is a dedicated device.",
"This device is required to have an authenticated user."
],
"location": "query",
"type": "string"
},
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/createEnrollmentToken",
"response": {
"$ref": "CreateEnrollmentTokenResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"createWebToken": {
"description": "Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/createWebToken",
Expand Down Expand Up @@ -575,7 +614,7 @@
"parameterOrder": [],
"parameters": {
"requestMode": {
"description": "The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.",
"description": "The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Specifying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.",
"enum": [
"waitForNotifications",
"returnImmediately"
Expand Down Expand Up @@ -2610,7 +2649,7 @@
}
}
},
"revision": "20221208",
"revision": "20221214",
"rootUrl": "https://androidenterprise.googleapis.com/",
"schemas": {
"Administrator": {
Expand Down Expand Up @@ -3099,6 +3138,17 @@
},
"type": "object"
},
"CreateEnrollmentTokenResponse": {
"description": "Response message for create enrollment token.",
"id": "CreateEnrollmentTokenResponse",
"properties": {
"enrollmentToken": {
"description": "Enrollment token.",
"type": "string"
}
},
"type": "object"
},
"Device": {
"description": "A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.",
"id": "Device",
Expand Down

0 comments on commit ec22103

Please sign in to comment.