Skip to content

Commit 0015176

Browse files
feat(androidmanagement): update the API
#### androidmanagement:v1 The following keys were added: - schemas.Command.properties.wipeParams.$ref - schemas.Command.properties.wipeParams.description - schemas.WipeParams.description - schemas.WipeParams.id - schemas.WipeParams.properties.wipeDataFlags.description - schemas.WipeParams.properties.wipeDataFlags.items.enum - schemas.WipeParams.properties.wipeDataFlags.items.enumDescriptions - schemas.WipeParams.properties.wipeDataFlags.items.type - schemas.WipeParams.properties.wipeDataFlags.type - schemas.WipeParams.properties.wipeReason.$ref - schemas.WipeParams.properties.wipeReason.description - schemas.WipeParams.type The following keys were changed: - schemas.ApplicationPolicy.properties.userControlSettings.enumDescriptions - schemas.Command.properties.type.enum - schemas.Command.properties.type.enumDescriptions - schemas.ExtensionConfig.properties.notificationReceiver.description
1 parent ef25b1f commit 0015176

File tree

3 files changed

+62
-8
lines changed

3 files changed

+62
-8
lines changed

‎discovery/androidmanagement-v1.json

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1260,7 +1260,7 @@
12601260
}
12611261
}
12621262
},
1263-
"revision": "20250625",
1263+
"revision": "20250702",
12641264
"rootUrl": "https://androidmanagement.googleapis.com/",
12651265
"schemas": {
12661266
"AdbShellCommandEvent": {
@@ -2242,7 +2242,7 @@
22422242
"USER_CONTROL_DISALLOWED"
22432243
],
22442244
"enumDescriptions": [
2245-
"Uses the default behaviour of the app to determine if user control is allowed or disallowed. For most apps, user control is allowed by default, but user control is disallowed for some critical apps such as: * extension apps (see extensionConfig for more details) * kiosk apps (see KIOSK install type for more details) * other critical system apps",
2245+
"Uses the default behaviour of the app to determine if user control is allowed or disallowed. User control is allowed by default for most apps but disallowed for following types of apps: extension apps (see extensionConfig for more details) kiosk apps (see KIOSK install type for more details) other critical system apps",
22462246
"User control is allowed for the app. Kiosk apps can use this to allow user control. For extension apps (see extensionConfig for more details), user control is disallowed even if this value is set. For kiosk apps (see KIOSK install type for more details), this value can be used to allow user control.",
22472247
"User control is disallowed for the app. This is supported on Android 11 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 11."
22482248
],
@@ -2692,7 +2692,8 @@
26922692
"STOP_LOST_MODE",
26932693
"ADD_ESIM",
26942694
"REMOVE_ESIM",
2695-
"REQUEST_DEVICE_INFO"
2695+
"REQUEST_DEVICE_INFO",
2696+
"WIPE"
26962697
],
26972698
"enumDescriptions": [
26982699
"This value is disallowed.",
@@ -2705,13 +2706,18 @@
27052706
"Takes the device out of lost mode. Only supported on fully managed devices or organization-owned devices with a managed profile. See also stop_lost_mode_params.",
27062707
"Adds an eSIM profile to the device. This is supported on Android 15 and above. See also addEsimParams. To remove an eSIM profile, use the REMOVE_ESIM command. To determine what happens to the eSIM profile when a device is wiped, set wipeDataFlags in the policy. Note: To provision multiple eSIMs on a single device, it is recommended to introduce a delay of a few minutes between successive executions of the command.",
27072708
"Removes an eSIM profile from the device. This is supported on Android 15 and above. See also removeEsimParams.",
2708-
"Request information related to the device."
2709+
"Request information related to the device.",
2710+
"Wipes the device, via a factory reset for a company owned device, or by deleting the work profile for a personally owned device with work profile. The wipe only occurs once the device acknowledges the command. The command can be cancelled before then."
27092711
],
27102712
"type": "string"
27112713
},
27122714
"userName": {
27132715
"description": "The resource name of the user that owns the device in the form enterprises/{enterpriseId}/users/{userId}. This is automatically generated by the server based on the device the command is sent to.",
27142716
"type": "string"
2717+
},
2718+
"wipeParams": {
2719+
"$ref": "WipeParams",
2720+
"description": "Optional. Parameters for the WIPE command to wipe the device. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to WIPE. It is also acceptable to explicitly set type to WIPE."
27152721
}
27162722
},
27172723
"type": "object"
@@ -3904,7 +3910,7 @@
39043910
"id": "ExtensionConfig",
39053911
"properties": {
39063912
"notificationReceiver": {
3907-
"description": "Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates.",
3913+
"description": "Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. The service must be exported in the extension app's AndroidManifest.xml and extend NotificationReceiverService (https://developers.google.com/android/management/reference/amapi/com/google/android/managementapi/notification/NotificationReceiverService) (see Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details).",
39083914
"type": "string"
39093915
},
39103916
"signingKeyFingerprintsSha256": {
@@ -7850,6 +7856,36 @@
78507856
"properties": {},
78517857
"type": "object"
78527858
},
7859+
"WipeParams": {
7860+
"description": "Parameters associated with the WIPE command to wipe the device.",
7861+
"id": "WipeParams",
7862+
"properties": {
7863+
"wipeDataFlags": {
7864+
"description": "Optional. Flags to determine what data to wipe.",
7865+
"items": {
7866+
"enum": [
7867+
"WIPE_DATA_FLAG_UNSPECIFIED",
7868+
"PRESERVE_RESET_PROTECTION_DATA",
7869+
"WIPE_EXTERNAL_STORAGE",
7870+
"WIPE_ESIMS"
7871+
],
7872+
"enumDescriptions": [
7873+
"This value is ignored.",
7874+
"Preserve the factory reset protection data on the device.",
7875+
"Additionally wipe the device's external storage (such as SD cards).",
7876+
"For company-owned devices, this removes all eSIMs from the device when the device is wiped. In personally-owned devices, this will remove managed eSIMs (eSIMs which are added via the ADD_ESIM command) on the devices and no personally owned eSIMs will be removed."
7877+
],
7878+
"type": "string"
7879+
},
7880+
"type": "array"
7881+
},
7882+
"wipeReason": {
7883+
"$ref": "UserFacingMessage",
7884+
"description": "Optional. A short message displayed to the user before wiping the work profile on personal devices. This has no effect on company owned devices. The maximum message length is 200 characters."
7885+
}
7886+
},
7887+
"type": "object"
7888+
},
78537889
"WorkAccountSetupConfig": {
78547890
"description": "Controls the work account setup configuration, such as details of whether a Google authenticated account is required.",
78557891
"id": "WorkAccountSetupConfig",

‎src/apis/androidmanagement/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"webpack": "webpack"
2929
},
3030
"dependencies": {
31-
"googleapis-common": "^8.0.0"
31+
"googleapis-common": "^8.0.2-rc.0"
3232
},
3333
"devDependencies": {
3434
"@microsoft/api-documenter": "^7.8.10",

‎src/apis/androidmanagement/v1.ts

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -875,6 +875,10 @@ export namespace androidmanagement_v1 {
875875
* The resource name of the user that owns the device in the form enterprises/{enterpriseId\}/users/{userId\}. This is automatically generated by the server based on the device the command is sent to.
876876
*/
877877
userName?: string | null;
878+
/**
879+
* Optional. Parameters for the WIPE command to wipe the device. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to WIPE. It is also acceptable to explicitly set type to WIPE.
880+
*/
881+
wipeParams?: Schema$WipeParams;
878882
}
879883
/**
880884
* Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy.
@@ -1545,7 +1549,7 @@ export namespace androidmanagement_v1 {
15451549
*/
15461550
export interface Schema$ExtensionConfig {
15471551
/**
1548-
* Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates.
1552+
* Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. The service must be exported in the extension app's AndroidManifest.xml and extend NotificationReceiverService (https://developers.google.com/android/management/reference/amapi/com/google/android/managementapi/notification/NotificationReceiverService) (see Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details).
15491553
*/
15501554
notificationReceiver?: string | null;
15511555
/**
@@ -3814,6 +3818,19 @@ export namespace androidmanagement_v1 {
38143818
* The work profile or company-owned device failed to wipe when requested. This could be user initiated or admin initiated e.g. delete was received. Intentionally empty.
38153819
*/
38163820
export interface Schema$WipeFailureEvent {}
3821+
/**
3822+
* Parameters associated with the WIPE command to wipe the device.
3823+
*/
3824+
export interface Schema$WipeParams {
3825+
/**
3826+
* Optional. Flags to determine what data to wipe.
3827+
*/
3828+
wipeDataFlags?: string[] | null;
3829+
/**
3830+
* Optional. A short message displayed to the user before wiping the work profile on personal devices. This has no effect on company owned devices. The maximum message length is 200 characters.
3831+
*/
3832+
wipeReason?: Schema$UserFacingMessage;
3833+
}
38173834
/**
38183835
* Controls the work account setup configuration, such as details of whether a Google authenticated account is required.
38193836
*/
@@ -5412,7 +5429,8 @@ export namespace androidmanagement_v1 {
54125429
* // "stopLostModeParams": {},
54135430
* // "stopLostModeStatus": {},
54145431
* // "type": "my_type",
5415-
* // "userName": "my_userName"
5432+
* // "userName": "my_userName",
5433+
* // "wipeParams": {}
54165434
* // }
54175435
* },
54185436
* });

0 commit comments

Comments
 (0)