Skip to content

Commit 5463175

Browse files
feat(androidenterprise): update the api
#### androidenterprise:v1 The following keys were added: - resources.enterprises.methods.createEnrollmentToken.parameters.deviceType.deprecated (Total Keys: 1) - resources.enterprises.methods.createEnrollmentToken.parameters.enrollmentToken.duration (Total Keys: 3) - resources.enterprises.methods.createEnrollmentToken.parameters.enrollmentToken.enrollmentTokenType (Total Keys: 2) - resources.enterprises.methods.createEnrollmentToken.parameters.enrollmentToken.token (Total Keys: 2) - schemas.CreateEnrollmentTokenResponse.properties.enrollmentToken.deprecated (Total Keys: 1) - schemas.CreateEnrollmentTokenResponse.properties.token.$ref (Total Keys: 1) - schemas.EnrollmentToken (Total Keys: 6)
1 parent 357c35b commit 5463175

File tree

2 files changed

+83
-9
lines changed

2 files changed

+83
-9
lines changed

docs/dyn/androidenterprise_v1.enterprises.html

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ <h2>Instance Methods</h2>
8484
<code><a href="#completeSignup">completeSignup(completionToken=None, enterpriseToken=None, x__xgafv=None)</a></code></p>
8585
<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>
8686
<p class="toc_element">
87-
<code><a href="#createEnrollmentToken">createEnrollmentToken(enterpriseId, deviceType=None, x__xgafv=None)</a></code></p>
87+
<code><a href="#createEnrollmentToken">createEnrollmentToken(enterpriseId, deviceType=None, enrollmentToken_duration=None, enrollmentToken_enrollmentTokenType=None, enrollmentToken_token=None, x__xgafv=None)</a></code></p>
8888
<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>
8989
<p class="toc_element">
9090
<code><a href="#createWebToken">createWebToken(enterpriseId, body=None, x__xgafv=None)</a></code></p>
@@ -173,16 +173,23 @@ <h3>Method Details</h3>
173173
</div>
174174

175175
<div class="method">
176-
<code class="details" id="createEnrollmentToken">createEnrollmentToken(enterpriseId, deviceType=None, x__xgafv=None)</code>
176+
<code class="details" id="createEnrollmentToken">createEnrollmentToken(enterpriseId, deviceType=None, enrollmentToken_duration=None, enrollmentToken_enrollmentTokenType=None, enrollmentToken_token=None, x__xgafv=None)</code>
177177
<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.
178178

179179
Args:
180-
enterpriseId: string, The ID of the enterprise. (required)
181-
deviceType: string, Whether it’s a dedicated device or a knowledge worker device.
180+
enterpriseId: string, Required. The ID of the enterprise. (required)
181+
deviceType: string, Deprecated: Use enrollment_token instead. this field will be removed in the future.
182182
Allowed values
183183
unknown - This value is unused
184184
dedicatedDevice - This device is a dedicated device.
185185
knowledgeWorker - This device is required to have an authenticated user.
186+
enrollmentToken_duration: string, [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.
187+
enrollmentToken_enrollmentTokenType: string, [Required] The type of the enrollment token.
188+
Allowed values
189+
enrollmentTokenTypeUnspecified - The value is unused.
190+
userlessDevice - The enrollment token is for a userless device.
191+
userDevice - The enrollment token is for a user device.
192+
enrollmentToken_token: string, 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.
186193
x__xgafv: string, V1 error format.
187194
Allowed values
188195
1 - v1 error format
@@ -192,7 +199,12 @@ <h3>Method Details</h3>
192199
An object of the form:
193200

194201
{ # Response message for create enrollment token.
195-
&quot;enrollmentToken&quot;: &quot;A String&quot;, # Enrollment token.
202+
&quot;enrollmentToken&quot;: &quot;A String&quot;, # Deprecated: Use token instead. This field will be removed in the future.
203+
&quot;token&quot;: { # A token used to enroll a device. # [Required] The created enrollment token.
204+
&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.
205+
&quot;enrollmentTokenType&quot;: &quot;A String&quot;, # [Required] The type of the enrollment token.
206+
&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.
207+
},
196208
}</pre>
197209
</div>
198210

googleapiclient/discovery_cache/documents/androidenterprise.v1.json

Lines changed: 66 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,8 @@
393393
],
394394
"parameters": {
395395
"deviceType": {
396-
"description": "Whether it\u2019s a dedicated device or a knowledge worker device.",
396+
"deprecated": true,
397+
"description": "Deprecated: Use enrollment_token instead. this field will be removed in the future.",
397398
"enum": [
398399
"unknown",
399400
"dedicatedDevice",
@@ -407,8 +408,34 @@
407408
"location": "query",
408409
"type": "string"
409410
},
411+
"enrollmentToken.duration": {
412+
"description": "[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.",
413+
"format": "google-duration",
414+
"location": "query",
415+
"type": "string"
416+
},
417+
"enrollmentToken.enrollmentTokenType": {
418+
"description": "[Required] The type of the enrollment token.",
419+
"enum": [
420+
"enrollmentTokenTypeUnspecified",
421+
"userlessDevice",
422+
"userDevice"
423+
],
424+
"enumDescriptions": [
425+
"The value is unused.",
426+
"The enrollment token is for a userless device.",
427+
"The enrollment token is for a user device."
428+
],
429+
"location": "query",
430+
"type": "string"
431+
},
432+
"enrollmentToken.token": {
433+
"description": "The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.",
434+
"location": "query",
435+
"type": "string"
436+
},
410437
"enterpriseId": {
411-
"description": "The ID of the enterprise.",
438+
"description": "Required. The ID of the enterprise.",
412439
"location": "path",
413440
"required": true,
414441
"type": "string"
@@ -2654,7 +2681,7 @@
26542681
}
26552682
}
26562683
},
2657-
"revision": "20241028",
2684+
"revision": "20241113",
26582685
"rootUrl": "https://androidenterprise.googleapis.com/",
26592686
"schemas": {
26602687
"Administrator": {
@@ -3153,8 +3180,13 @@
31533180
"id": "CreateEnrollmentTokenResponse",
31543181
"properties": {
31553182
"enrollmentToken": {
3156-
"description": "Enrollment token.",
3183+
"deprecated": true,
3184+
"description": "Deprecated: Use token instead. This field will be removed in the future.",
31573185
"type": "string"
3186+
},
3187+
"token": {
3188+
"$ref": "EnrollmentToken",
3189+
"description": "[Required] The created enrollment token."
31583190
}
31593191
},
31603192
"type": "object"
@@ -3293,6 +3325,36 @@
32933325
},
32943326
"type": "object"
32953327
},
3328+
"EnrollmentToken": {
3329+
"description": "A token used to enroll a device.",
3330+
"id": "EnrollmentToken",
3331+
"properties": {
3332+
"duration": {
3333+
"description": "[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.",
3334+
"format": "google-duration",
3335+
"type": "string"
3336+
},
3337+
"enrollmentTokenType": {
3338+
"description": "[Required] The type of the enrollment token.",
3339+
"enum": [
3340+
"enrollmentTokenTypeUnspecified",
3341+
"userlessDevice",
3342+
"userDevice"
3343+
],
3344+
"enumDescriptions": [
3345+
"The value is unused.",
3346+
"The enrollment token is for a userless device.",
3347+
"The enrollment token is for a user device."
3348+
],
3349+
"type": "string"
3350+
},
3351+
"token": {
3352+
"description": "The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.",
3353+
"type": "string"
3354+
}
3355+
},
3356+
"type": "object"
3357+
},
32963358
"Enterprise": {
32973359
"description": "An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. - For managed Google Play Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.",
32983360
"id": "Enterprise",

0 commit comments

Comments
 (0)