You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/androidmanagement_v1.enterprises.devices.html
+28Lines changed: 28 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -117,6 +117,7 @@ <h3>Method Details</h3>
117
117
WIPE_DATA_FLAG_UNSPECIFIED - This value is ignored.
118
118
PRESERVE_RESET_PROTECTION_DATA - Preserve the factory reset protection data on the device.
119
119
WIPE_EXTERNAL_STORAGE - Additionally wipe the device's external storage (such as SD cards).
120
+
WIPE_ESIMS - 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.
120
121
wipeReasonMessage: string, 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.
121
122
x__xgafv: string, V1 error format.
122
123
Allowed values
@@ -319,7 +320,9 @@ <h3>Method Details</h3>
319
320
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
320
321
"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
321
322
{ # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
323
+
"activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35.
322
324
"carrierName": "A String", # The carrier name associated with this SIM card.
325
+
"configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35.
323
326
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
324
327
"phoneNumber": "A String", # The phone number associated with this SIM card.
325
328
},
@@ -411,6 +414,10 @@ <h3>Method Details</h3>
411
414
The object takes the form of:
412
415
413
416
{ # A command.
417
+
"addEsimParams": { # Parameters associated with the ADD_ESIM command to add an eSIM profile to the device. # Optional. Parameters for the ADD_ESIM command to add an eSIM profile to 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 ADD_ESIM. It is also acceptable to explicitly set type to ADD_ESIM.
418
+
"activationCode": "A String", # Required. The activation code for the eSIM profile.
419
+
"activationState": "A String", # Required. The activation state of the eSIM profile once it is downloaded.
420
+
},
414
421
"clearAppsDataParams": { # Parameters associated with the CLEAR_APP_DATA command to clear the data of specified apps from the device. # Parameters for the CLEAR_APP_DATA command to clear the data of specified apps from the device. See ClearAppsDataParams. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to CLEAR_APP_DATA. It is also acceptable to explicitly set type to CLEAR_APP_DATA.
415
422
"packageNames": [ # The package names of the apps whose data will be cleared when the command is executed.
416
423
"A String",
@@ -426,7 +433,22 @@ <h3>Method Details</h3>
426
433
"createTime": "A String", # The timestamp at which the command was created. The timestamp is automatically generated by the server.
427
434
"duration": "A String", # The duration for which the command is valid. The command will expire if not executed by the device during this time. The default duration if unspecified is ten minutes. There is no maximum duration.
428
435
"errorCode": "A String", # If the command failed, an error code explaining the failure. This is not set when the command is cancelled by the caller. For reasoning about command errors, prefer fields in the following order (most preferred first): 1. Command-specific fields like clearAppsDataStatus, startLostModeStatus, or similar, if they exist. 2. This field, if set. 3. The generic error field in the Operation that wraps the command.
436
+
"esimStatus": { # Status and error details (if present) of an ADD_ESIM or REMOVE_ESIM command. # Output only. Status of an ADD_ESIM or REMOVE_ESIM command.
437
+
"esimInfo": { # Details of the eSIM added or removed. # Output only. Information about the eSIM added or removed. This is populated only when the eSIM operation status is SUCCESS.
438
+
"iccId": "A String", # Output only. ICC ID of the eSIM.
439
+
},
440
+
"internalErrorDetails": { # Internal error details if present for the ADD_ESIM or REMOVE_ESIM command. # Output only. Details of the error if the status is set to INTERNAL_ERROR.
441
+
"errorCode": "A String", # Output only. Integer representation of the error code as specified here (https://developer.android.com/reference/android/telephony/euicc/EuiccManager#EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE). See also, OPERATION_SMDX_SUBJECT_REASON_CODE. See error_code_detail for more details.
442
+
"errorCodeDetail": "A String", # Output only. The error code detail corresponding to the error_code.
443
+
"operationCode": "A String", # Output only. Integer representation of the operation code as specified here (https://developer.android.com/reference/android/telephony/euicc/EuiccManager#EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE). See operation_code_detail for more details.
444
+
"operationCodeDetail": "A String", # Output only. The operation code detail corresponding to the operation_code.
445
+
},
446
+
"status": "A String", # Output only. Status of an ADD_ESIM or REMOVE_ESIM command.
447
+
},
429
448
"newPassword": "A String", # For commands of type RESET_PASSWORD, optionally specifies the new password. Note: The new password must be at least 6 characters long if it is numeric in case of Android 14 devices. Else the command will fail with INVALID_VALUE.
449
+
"removeEsimParams": { # Parameters associated with the REMOVE_ESIM command to remove an eSIM profile from the device. # Optional. Parameters for the REMOVE_ESIM command to remove an eSIM profile from 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 REMOVE_ESIM. It is also acceptable to explicitly set type to REMOVE_ESIM.
450
+
"iccId": "A String", # Required. ICC ID of the eSIM profile to be deleted.
451
+
},
430
452
"requestDeviceInfoParams": { # Parameters associated with the REQUEST_DEVICE_INFO command to get device related information. # Optional. Parameters for the REQUEST_DEVICE_INFO command to get device related information. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to REQUEST_DEVICE_INFO . It is also acceptable to explicitly set type to REQUEST_DEVICE_INFO.
431
453
"deviceInfo": "A String", # Required. Type of device information to be requested.
432
454
},
@@ -704,7 +726,9 @@ <h3>Method Details</h3>
704
726
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
705
727
"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
706
728
{ # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
729
+
"activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35.
707
730
"carrierName": "A String", # The carrier name associated with this SIM card.
731
+
"configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35.
708
732
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
709
733
"phoneNumber": "A String", # The phone number associated with this SIM card.
710
734
},
@@ -987,7 +1011,9 @@ <h3>Method Details</h3>
987
1011
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
988
1012
"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
989
1013
{ # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
1014
+
"activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35.
990
1015
"carrierName": "A String", # The carrier name associated with this SIM card.
1016
+
"configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35.
991
1017
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
992
1018
"phoneNumber": "A String", # The phone number associated with this SIM card.
993
1019
},
@@ -1252,7 +1278,9 @@ <h3>Method Details</h3>
1252
1278
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
1253
1279
"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
1254
1280
{ # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
1281
+
"activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35.
1255
1282
"carrierName": "A String", # The carrier name associated with this SIM card.
1283
+
"configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35.
1256
1284
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
1257
1285
"phoneNumber": "A String", # The phone number associated with this SIM card.
0 commit comments