Skip to content

Commit 775e9ff

Browse files
yoshi-automationsofisl
authored andcommitted
feat(androidenterprise)!: update the API
BREAKING CHANGE: This release has breaking changes. #### androidenterprise:v1 The following keys were deleted: - resources.enterprises.methods.createEnrollmentToken.description - resources.enterprises.methods.createEnrollmentToken.flatPath - resources.enterprises.methods.createEnrollmentToken.httpMethod - resources.enterprises.methods.createEnrollmentToken.id - resources.enterprises.methods.createEnrollmentToken.parameterOrder - resources.enterprises.methods.createEnrollmentToken.parameters.deviceType.description - resources.enterprises.methods.createEnrollmentToken.parameters.deviceType.enum - resources.enterprises.methods.createEnrollmentToken.parameters.deviceType.enumDescriptions - resources.enterprises.methods.createEnrollmentToken.parameters.deviceType.location - resources.enterprises.methods.createEnrollmentToken.parameters.deviceType.type - resources.enterprises.methods.createEnrollmentToken.parameters.enterpriseId.description - resources.enterprises.methods.createEnrollmentToken.parameters.enterpriseId.location - resources.enterprises.methods.createEnrollmentToken.parameters.enterpriseId.required - resources.enterprises.methods.createEnrollmentToken.parameters.enterpriseId.type - resources.enterprises.methods.createEnrollmentToken.path - resources.enterprises.methods.createEnrollmentToken.response.$ref - resources.enterprises.methods.createEnrollmentToken.scopes - schemas.CreateEnrollmentTokenResponse.description - schemas.CreateEnrollmentTokenResponse.id - schemas.CreateEnrollmentTokenResponse.properties.enrollmentToken.description - schemas.CreateEnrollmentTokenResponse.properties.enrollmentToken.type - schemas.CreateEnrollmentTokenResponse.type The following keys were added: - resources.enrollmentTokens.methods.create.description - resources.enrollmentTokens.methods.create.flatPath - resources.enrollmentTokens.methods.create.httpMethod - resources.enrollmentTokens.methods.create.id - resources.enrollmentTokens.methods.create.parameterOrder - resources.enrollmentTokens.methods.create.parameters.enterpriseId.description - resources.enrollmentTokens.methods.create.parameters.enterpriseId.location - resources.enrollmentTokens.methods.create.parameters.enterpriseId.required - resources.enrollmentTokens.methods.create.parameters.enterpriseId.type - resources.enrollmentTokens.methods.create.path - resources.enrollmentTokens.methods.create.request.$ref - resources.enrollmentTokens.methods.create.response.$ref - resources.enrollmentTokens.methods.create.scopes - resources.enterprises.methods.generateSignupUrl.parameters.allowedDomains.description - resources.enterprises.methods.generateSignupUrl.parameters.allowedDomains.location - resources.enterprises.methods.generateSignupUrl.parameters.allowedDomains.repeated - resources.enterprises.methods.generateSignupUrl.parameters.allowedDomains.type - resources.serviceaccountkeys.deprecated - resources.serviceaccountkeys.methods.delete.deprecated - resources.serviceaccountkeys.methods.insert.deprecated - resources.serviceaccountkeys.methods.list.deprecated - schemas.EnrollmentToken.description - schemas.EnrollmentToken.id - schemas.EnrollmentToken.properties.duration.description - schemas.EnrollmentToken.properties.duration.format - schemas.EnrollmentToken.properties.duration.type - schemas.EnrollmentToken.properties.enrollmentTokenType.description - schemas.EnrollmentToken.properties.enrollmentTokenType.enum - schemas.EnrollmentToken.properties.enrollmentTokenType.enumDescriptions - schemas.EnrollmentToken.properties.enrollmentTokenType.type - schemas.EnrollmentToken.properties.token.description - schemas.EnrollmentToken.properties.token.type - schemas.EnrollmentToken.type - schemas.Policy.properties.policyId.description - schemas.Policy.properties.policyId.type - schemas.ServiceAccountKeysListResponse.deprecated The following keys were changed: - resources.enterprises.methods.generateSignupUrl.parameters.adminEmail.description - schemas.Policy.properties.autoUpdatePolicy.description
1 parent 1b0bf8a commit 775e9ff

File tree

2 files changed

+217
-173
lines changed

2 files changed

+217
-173
lines changed

‎discovery/androidenterprise-v1.json

Lines changed: 79 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -337,6 +337,37 @@
337337
}
338338
}
339339
},
340+
"enrollmentTokens": {
341+
"methods": {
342+
"create": {
343+
"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.",
344+
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/enrollmentTokens",
345+
"httpMethod": "POST",
346+
"id": "androidenterprise.enrollmentTokens.create",
347+
"parameterOrder": [
348+
"enterpriseId"
349+
],
350+
"parameters": {
351+
"enterpriseId": {
352+
"description": "Required. The ID of the enterprise.",
353+
"location": "path",
354+
"required": true,
355+
"type": "string"
356+
}
357+
},
358+
"path": "androidenterprise/v1/enterprises/{enterpriseId}/enrollmentTokens",
359+
"request": {
360+
"$ref": "EnrollmentToken"
361+
},
362+
"response": {
363+
"$ref": "EnrollmentToken"
364+
},
365+
"scopes": [
366+
"https://www.googleapis.com/auth/androidenterprise"
367+
]
368+
}
369+
}
370+
},
340371
"enterprises": {
341372
"methods": {
342373
"acknowledgeNotificationSet": {
@@ -383,45 +414,6 @@
383414
"https://www.googleapis.com/auth/androidenterprise"
384415
]
385416
},
386-
"createEnrollmentToken": {
387-
"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.",
388-
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/createEnrollmentToken",
389-
"httpMethod": "POST",
390-
"id": "androidenterprise.enterprises.createEnrollmentToken",
391-
"parameterOrder": [
392-
"enterpriseId"
393-
],
394-
"parameters": {
395-
"deviceType": {
396-
"description": "Whether it’s a dedicated device or a knowledge worker device.",
397-
"enum": [
398-
"unknown",
399-
"dedicatedDevice",
400-
"knowledgeWorker"
401-
],
402-
"enumDescriptions": [
403-
"This value is unused",
404-
"This device is a dedicated device.",
405-
"This device is required to have an authenticated user."
406-
],
407-
"location": "query",
408-
"type": "string"
409-
},
410-
"enterpriseId": {
411-
"description": "The ID of the enterprise.",
412-
"location": "path",
413-
"required": true,
414-
"type": "string"
415-
}
416-
},
417-
"path": "androidenterprise/v1/enterprises/{enterpriseId}/createEnrollmentToken",
418-
"response": {
419-
"$ref": "CreateEnrollmentTokenResponse"
420-
},
421-
"scopes": [
422-
"https://www.googleapis.com/auth/androidenterprise"
423-
]
424-
},
425417
"createWebToken": {
426418
"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.",
427419
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/createWebToken",
@@ -484,10 +476,16 @@
484476
"parameterOrder": [],
485477
"parameters": {
486478
"adminEmail": {
487-
"description": "Optional. Email address used to prefill the admin field of the enterprise signup form. This value is a hint only and can be altered by the user.",
479+
"description": "Optional. Email address used to prefill the admin field of the enterprise signup form. This value is a hint only and can be altered by the user. If `allowedDomains` is non-empty then this must belong to one of the `allowedDomains`.",
488480
"location": "query",
489481
"type": "string"
490482
},
483+
"allowedDomains": {
484+
"description": "Optional. A list of domains that are permitted for the admin email. The IT admin cannot enter an email address with a domain name that is not in this list. Subdomains of domains in this list are not allowed but can be allowed by adding a second entry which has `*.` prefixed to the domain name (e.g. *.example.com). If the field is not present or is an empty list then the IT admin is free to use any valid domain name. Personal email domains are always allowed, but will result in the creation of a managed Google Play Accounts enterprise.",
485+
"location": "query",
486+
"repeated": true,
487+
"type": "string"
488+
},
491489
"callbackUrl": {
492490
"description": "The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named \"enterpriseToken\" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.",
493491
"location": "query",
@@ -1813,8 +1811,10 @@
18131811
}
18141812
},
18151813
"serviceaccountkeys": {
1814+
"deprecated": true,
18161815
"methods": {
18171816
"delete": {
1817+
"deprecated": true,
18181818
"description": "Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.",
18191819
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys/{keyId}",
18201820
"httpMethod": "DELETE",
@@ -1843,6 +1843,7 @@
18431843
]
18441844
},
18451845
"insert": {
1846+
"deprecated": true,
18461847
"description": "Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount. Only the type of the key should be populated in the resource to be inserted.",
18471848
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys",
18481849
"httpMethod": "POST",
@@ -1870,6 +1871,7 @@
18701871
]
18711872
},
18721873
"list": {
1874+
"deprecated": true,
18731875
"description": "Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.",
18741876
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys",
18751877
"httpMethod": "GET",
@@ -2654,7 +2656,7 @@
26542656
}
26552657
}
26562658
},
2657-
"revision": "20240820",
2659+
"revision": "20250122",
26582660
"rootUrl": "https://androidenterprise.googleapis.com/",
26592661
"schemas": {
26602662
"Administrator": {
@@ -3148,17 +3150,6 @@
31483150
},
31493151
"type": "object"
31503152
},
3151-
"CreateEnrollmentTokenResponse": {
3152-
"description": "Response message for create enrollment token.",
3153-
"id": "CreateEnrollmentTokenResponse",
3154-
"properties": {
3155-
"enrollmentToken": {
3156-
"description": "Enrollment token.",
3157-
"type": "string"
3158-
}
3159-
},
3160-
"type": "object"
3161-
},
31623153
"Device": {
31633154
"description": "A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.",
31643155
"id": "Device",
@@ -3293,6 +3284,36 @@
32933284
},
32943285
"type": "object"
32953286
},
3287+
"EnrollmentToken": {
3288+
"description": "A token used to enroll a device.",
3289+
"id": "EnrollmentToken",
3290+
"properties": {
3291+
"duration": {
3292+
"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.",
3293+
"format": "google-duration",
3294+
"type": "string"
3295+
},
3296+
"enrollmentTokenType": {
3297+
"description": "[Required] The type of the enrollment token.",
3298+
"enum": [
3299+
"enrollmentTokenTypeUnspecified",
3300+
"userlessDevice",
3301+
"userDevice"
3302+
],
3303+
"enumDescriptions": [
3304+
"The value is unused.",
3305+
"The enrollment token is for a userless device.",
3306+
"The enrollment token is for a user device."
3307+
],
3308+
"type": "string"
3309+
},
3310+
"token": {
3311+
"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.",
3312+
"type": "string"
3313+
}
3314+
},
3315+
"type": "object"
3316+
},
32963317
"Enterprise": {
32973318
"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.",
32983319
"id": "Enterprise",
@@ -4015,7 +4036,7 @@
40154036
"properties": {
40164037
"autoUpdatePolicy": {
40174038
"deprecated": true,
4018-
"description": "Controls when automatic app updates on the device can be applied. Recommended alternative: autoUpdateMode which is set per app, provides greater flexibility around update frequency. When autoUpdateMode is set to AUTO_UPDATE_POSTPONED or AUTO_UPDATE_HIGH_PRIORITY, autoUpdatePolicy has no effect. \"choiceToTheUser\" allows the device's user to configure the app update policy. \"always\" enables auto updates. \"never\" disables auto updates. \"wifiOnly\" enables auto updates only when the device is connected to wifi.",
4039+
"description": "Controls when automatic app updates on the device can be applied. Recommended alternative: autoUpdateMode which is set per app, provides greater flexibility around update frequency. When autoUpdateMode is set to AUTO_UPDATE_POSTPONED or AUTO_UPDATE_HIGH_PRIORITY, autoUpdatePolicy has no effect. - choiceToTheUser allows the device's user to configure the app update policy. - always enables auto updates. - never disables auto updates. - wifiOnly enables auto updates only when the device is connected to wifi. *Important:* Changes to app update policies don't affect updates that are in progress. Any policy changes will apply to subsequent app updates. ",
40194040
"enum": [
40204041
"autoUpdatePolicyUnspecified",
40214042
"choiceToTheUser",
@@ -4050,6 +4071,10 @@
40504071
"$ref": "MaintenanceWindow",
40514072
"description": "The maintenance window defining when apps running in the foreground should be updated."
40524073
},
4074+
"policyId": {
4075+
"description": "An identifier for the policy that will be passed with the app install feedback sent from the Play Store.",
4076+
"type": "string"
4077+
},
40534078
"productAvailabilityPolicy": {
40544079
"description": "The availability granted to the device for the specified products. \"all\" gives the device access to all products, regardless of approval status. \"all\" does not enable automatic visibility of \"alpha\" or \"beta\" tracks. \"whitelist\" grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default.",
40554080
"enum": [
@@ -4618,6 +4643,7 @@
46184643
"type": "object"
46194644
},
46204645
"ServiceAccountKeysListResponse": {
4646+
"deprecated": true,
46214647
"id": "ServiceAccountKeysListResponse",
46224648
"properties": {
46234649
"serviceAccountKey": {

0 commit comments

Comments
 (0)