close()

Close httplib2 connections.

delete(name, wipeDataFlags=None, wipeReasonMessage=None, x__xgafv=None)

Deletes a device. This operation wipes the device. Deleted devices do not show up in enterprises.devices.list calls and a 404 is returned from enterprises.devices.get.

Args:
  name: string, The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. (required)
  wipeDataFlags: string, Optional flags that control the device wiping behavior. (repeated)
    Allowed values
      WIPE_DATA_FLAG_UNSPECIFIED - This value is ignored.
      PRESERVE_RESET_PROTECTION_DATA - Preserve the factory reset protection data on the device.
      WIPE_EXTERNAL_STORAGE - Additionally wipe the device's external storage (such as SD cards).
  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Gets a device. Deleted devices will respond with a 404 error.

Args:
name: string, The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.
"apiLevel": 42, # The API level of the Android platform version running on the device.
"applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy.
{ # Information reported about an installed app.
"applicationSource": "A String", # The source of the package.
"displayName": "A String", # The display name of the app.
"events": [ # The list of app events which have occurred in the last 30 hours.
{ # An app-related event.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # App event type.
},
],
"installerPackageName": "A String", # The package name of the app that installed this app.
"keyedAppStates": [ # List of keyed app states reported by the app.
{ # Keyed app state reported by the app.
"createTime": "A String", # The creation time of the app state on the device.
"data": "A String", # Optionally, a machine-readable value to be read by the EMM. For example, setting values that the admin can choose to query against in the EMM console (e.g. “notify me if the battery_warning data < 10”).
"key": "A String", # The key for the app state. Acts as a point of reference for what the app is providing state for. For example, when providing managed configuration feedback, this key could be the managed configuration key.
"lastUpdateTime": "A String", # The time the app state was most recently updated.
"message": "A String", # Optionally, a free-form message string to explain the app state. If the state was triggered by a particular value (e.g. a managed configuration value), it should be included in the message.
"severity": "A String", # The severity of the app state.
},
],
"packageName": "A String", # Package name of the app.
"packageSha256Hash": "A String", # The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number.
"signingKeyCertFingerprints": [ # The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number.
"A String",
],
"state": "A String", # Application state.
"userFacingType": "A String", # Whether the app is user facing.
"versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another.
"versionName": "A String", # The app version as displayed to the user.
},
],
"appliedPasswordPolicies": [ # The password requirements currently applied to the device. The applied requirements may be slightly different from those specified in passwordPolicies in some cases. fieldPath is set based on passwordPolicies.
{ # Requirements for the password used to unlock a device.
"maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction.
"passwordExpirationTimeout": "A String", # Password expiration timeout.
"passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction.
"passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX.
"passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordQuality": "A String", # The required password quality.
"passwordScope": "A String", # The scope that the password requirement applies to.
"requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile.
"unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION.
},
],
"appliedPolicyName": "A String", # The name of the policy currently applied to the device.
"appliedPolicyVersion": "A String", # The version of the policy currently applied to the device.
"appliedState": "A String", # The state currently applied to the device.
"commonCriteriaModeInfo": { # 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. # 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 the device is company-owned.
"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled.
"policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification.
},
"deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy.
"adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
"developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device.
"encryptionStatus": "A String", # Encryption status from DevicePolicyManager.
"isDeviceSecure": True or False, # Whether the device is secured with PIN/password.
"isEncrypted": True or False, # Whether the storage encryption is enabled.
"unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled.
"verifyAppsEnabled": True or False, # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced on the device.
},
"disabledReason": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # If the device state is DISABLED, an optional message that is displayed on the device indicating the reason the device is disabled. This field can be modified by a patch request.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
"displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.
{ # Device display information.
"density": 42, # Display density expressed as dots-per-inch.
"displayId": 42, # Unique display id.
"height": 42, # Display height in pixels.
"name": "A String", # Name of the display.
"refreshRate": 42, # Refresh rate of the display in frames per second.
"state": "A String", # State of the display.
"width": 42, # Display width in pixels.
},
],
"dpcMigrationInfo": { # Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC). # Output only. Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC).
"additionalData": "A String", # Output only. If this device was migrated from another DPC, the additionalData field of the migration token is populated here.
"previousDpc": "A String", # Output only. If this device was migrated from another DPC, this is its package name. Not populated otherwise.
},
"enrollmentTime": "A String", # The time of device enrollment.
"enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data.
"enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token.
"hardwareInfo": { # Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy. # Detailed information about the device hardware.
"batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device.
3.14,
],
"batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device.
3.14,
],
"brand": "A String", # Brand of the device. For example, Google.
"cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p.
"enterpriseSpecificId": "A String", # Output only. ID that uniquely identifies a personally-owned device in a particular organization. On the same physical device when enrolled with the same organization, this ID persists across setups and even factory resets. This ID is available on personally-owned devices with a work profile on devices running Android 12 and above.
"gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"hardware": "A String", # Name of the hardware. For example, Angler.
"manufacturer": "A String", # Manufacturer. For example, Motorola.
"model": "A String", # The model of the device. For example, Asus Nexus 7.
"serialNumber": "A String", # The device serial number.
"skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius.
3.14,
],
"skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius.
3.14,
],
},
"hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.
{ # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health.
"batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device.
3.14,
],
"cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device.
3.14,
],
"cpuUsages": [ # CPU usages in percentage for each core available on the device. Usage is 0 for each unplugged core. Empty array implies that CPU usage is not supported in the system.
3.14,
],
"createTime": "A String", # The time the measurements were taken.
"fanSpeeds": [ # Fan speeds in RPM for each fan on the device. Empty array means that there are no fans or fan speed is not supported on the system.
3.14,
],
"gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device.
3.14,
],
"skinTemperatures": [ # Current device skin temperatures in Celsius.
3.14,
],
},
],
"lastPolicyComplianceReportTime": "A String", # Deprecated.
"lastPolicySyncTime": "A String", # The last time the device fetched its policy.
"lastStatusReportTime": "A String", # The last time the device sent a status report.
"managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported.
"memoryEvents": [ # Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy.Events are retained for a certain period of time and old events are deleted.
{ # An event related to memory and storage measurements.To distinguish between new and old events, we recommend using the createTime field.
"byteCount": "A String", # The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"memoryInfo": { # Information about device memory and storage. # Memory information: contains information about device memory and storage.
"totalInternalStorage": "A String", # Total internal storage on device in bytes.
"totalRam": "A String", # Total RAM on device in bytes.
},
"name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
"networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy.
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212.
"meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1.
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
{ # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
"carrierName": "A String", # The carrier name associated with this SIM card.
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
"phoneNumber": "A String", # The phone number associated with this SIM card.
},
],
"wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11.
},
"nonComplianceDetails": [ # Details about policy settings that the device is not compliant with.
{ # Provides detail about non-compliance with a policy setting.
"currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device.
"fieldPath": "A String", # For settings with nested fields, if a particular nested field is out of compliance, this specifies the full path to the offending field. The path is formatted in the same way the policy JSON field would be referenced in JavaScript, that is: 1) For object-typed fields, the field name is followed by a dot then by a subfield name. 2) For array-typed fields, the field name is followed by the array index enclosed in brackets. For example, to indicate a problem with the url field in the externalData field in the 3rd application, the path would be applications[2].externalData.url
"installationFailureReason": "A String", # If package_name is set and the non-compliance reason is APP_NOT_INSTALLED or APP_NOT_UPDATED, the detailed reason the app can't be installed or updated.
"nonComplianceReason": "A String", # The reason the device is not in compliance with the setting.
"packageName": "A String", # The package name indicating which app is out of compliance, if applicable.
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
},
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
"passwordPolicyScope": "A String", # The scope of non-compliant password.
},
},
"specificNonComplianceReason": "A String", # The policy-specific reason the device is not in compliance with the setting.
},
],
"ownership": "A String", # Ownership of the managed device.
"policyCompliant": True or False, # Whether the device is compliant with its policy.
"policyName": "A String", # The name of the policy applied to the device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device's user is applied. This field can be modified by a patch request. You can specify only the policyId when calling enterprises.devices.patch, as long as the policyId doesn’t contain any slashes. The rest of the policy name is inferred.
"powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.
{ # A power management event.
"batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"previousDeviceNames": [ # If the same physical device has been enrolled multiple times, this field contains its previous device names. The serial number is used as the unique identifier to determine if the same physical device has enrolled previously. The names are in chronological order.
"A String",
],
"securityPosture": { # The security posture of the device, as determined by the current device state and the policies applied. # Device's security posture value that reflects how secure the device is.
"devicePosture": "A String", # Device's security posture value.
"postureDetails": [ # Additional details regarding the security posture of the device.
{ # Additional details regarding the security posture of the device.
"advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device.
{ # Provides a user-facing message with locale info. The maximum message length is 4096 characters.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
],
"securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device.
},
],
},
"softwareInfo": { # Information about device software. # Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy.
"androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.
"androidBuildTime": "A String", # Build time.
"androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code.
"androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user.
"androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1.
"bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7.
"deviceBuildSignature": "A String", # SHA-256 hash of android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the system package, which can be used to verify that the system build hasn't been modified.
"deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848.
"primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device.
"securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01.
"systemUpdateInfo": { # Information about a potential pending system update. # Information about a potential pending system update.
"updateReceivedTime": "A String", # The time when the update was first available. A zero value indicates that this field is not set. This field is set only if an update is available (that is, updateStatus is neither UPDATE_STATUS_UNKNOWN nor UP_TO_DATE).
"updateStatus": "A String", # The status of an update: whether an update exists and what type it is.
},
},
"state": "A String", # The state to be applied to the device. This field can be modified by a patch request. Note that when calling enterprises.devices.patch, ACTIVE and DISABLED are the only allowable values. To enter the device into a DELETED state, call enterprises.devices.delete.
"systemProperties": { # Map of selected system properties name and value related to the device. This information is only available if systemPropertiesEnabled is true in the device's policy.
"a_key": "A String",
},
"user": { # A user belonging to an enterprise. # The user who owns the device.
"accountIdentifier": "A String", # A unique identifier you create for this user, such as user342 or asset#44418. This field must be set when the user is created and can't be updated. This field must not contain personally identifiable information (PII). This identifier must be 1024 characters or less; otherwise, the update policy request will fail.
},
"userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.
}

issueCommand(name, body=None, x__xgafv=None)

Issues a command to a device. The Operation resource returned contains a Command in its metadata field. Use the get operation method to get the status of the command.

Args:
name: string, The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. (required)
body: object, The request body.
The object takes the form of:

{ # A command.
"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.
"packageNames": [ # The package names of the apps whose data will be cleared when the command is executed.
"A String",
],
},
"clearAppsDataStatus": { # Status of the CLEAR_APP_DATA command to clear the data of specified apps from the device. # Output only. Status of the CLEAR_APP_DATA command to clear the data of specified apps from the device. See ClearAppsDataStatus.
"results": { # The per-app results, a mapping from package names to the respective clearing result.
"a_key": { # The result of an attempt to clear the data of a single app.
"clearingResult": "A String", # The result of an attempt to clear the data of a single app.
},
},
},
"createTime": "A String", # The timestamp at which the command was created. The timestamp is automatically generated by the server.
"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.
"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.
"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.
"resetPasswordFlags": [ # For commands of type RESET_PASSWORD, optionally specifies flags.
"A String",
],
"startLostModeParams": { # Parameters associated with the START_LOST_MODE command to put the device into lost mode. At least one of the parameters, not including the organization name, must be provided in order for the device to be put into lost mode. # Parameters for the START_LOST_MODE command to put the device into lost mode. See StartLostModeParams. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to START_LOST_MODE. It is also acceptable to explicitly set type to START_LOST_MODE.
"lostEmailAddress": "A String", # The email address displayed to the user when the device is in lost mode.
"lostMessage": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # The message displayed to the user when the device is in lost mode.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
"lostOrganization": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # The organization name displayed to the user when the device is in lost mode.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
"lostPhoneNumber": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # The phone number that will be called when the device is in lost mode and the call owner button is tapped.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
"lostStreetAddress": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # The street address displayed to the user when the device is in lost mode.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
},
"startLostModeStatus": { # Status of the START_LOST_MODE command to put the device into lost mode. # Output only. Status of the START_LOST_MODE command to put the device into lost mode. See StartLostModeStatus.
"status": "A String", # The status. See StartLostModeStatus.
},
"stopLostModeParams": { # Parameters associated with the STOP_LOST_MODE command to take the device out of lost mode. # Parameters for the STOP_LOST_MODE command to take the device out of lost mode. See StopLostModeParams. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to STOP_LOST_MODE. It is also acceptable to explicitly set type to STOP_LOST_MODE.
},
"stopLostModeStatus": { # Status of the STOP_LOST_MODE command to take the device out of lost mode. # Output only. Status of the STOP_LOST_MODE command to take the device out of lost mode. See StopLostModeStatus.
"status": "A String", # The status. See StopLostModeStatus.
},
"type": "A String", # The type of the command.
"userName": "A String", # 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.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists devices for a given enterprise. Deleted devices are not returned in the response.

Args:
parent: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
pageSize: integer, The requested page size. The actual page size may be fixed to a min or max value.
pageToken: string, A token identifying a page of results returned by the server.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response to a request to list devices for a given enterprise.
"devices": [ # The list of devices.
{ # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.
"apiLevel": 42, # The API level of the Android platform version running on the device.
"applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy.
{ # Information reported about an installed app.
"applicationSource": "A String", # The source of the package.
"displayName": "A String", # The display name of the app.
"events": [ # The list of app events which have occurred in the last 30 hours.
{ # An app-related event.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # App event type.
},
],
"installerPackageName": "A String", # The package name of the app that installed this app.
"keyedAppStates": [ # List of keyed app states reported by the app.
{ # Keyed app state reported by the app.
"createTime": "A String", # The creation time of the app state on the device.
"data": "A String", # Optionally, a machine-readable value to be read by the EMM. For example, setting values that the admin can choose to query against in the EMM console (e.g. “notify me if the battery_warning data < 10”).
"key": "A String", # The key for the app state. Acts as a point of reference for what the app is providing state for. For example, when providing managed configuration feedback, this key could be the managed configuration key.
"lastUpdateTime": "A String", # The time the app state was most recently updated.
"message": "A String", # Optionally, a free-form message string to explain the app state. If the state was triggered by a particular value (e.g. a managed configuration value), it should be included in the message.
"severity": "A String", # The severity of the app state.
},
],
"packageName": "A String", # Package name of the app.
"packageSha256Hash": "A String", # The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number.
"signingKeyCertFingerprints": [ # The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number.
"A String",
],
"state": "A String", # Application state.
"userFacingType": "A String", # Whether the app is user facing.
"versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another.
"versionName": "A String", # The app version as displayed to the user.
},
],
"appliedPasswordPolicies": [ # The password requirements currently applied to the device. The applied requirements may be slightly different from those specified in passwordPolicies in some cases. fieldPath is set based on passwordPolicies.
{ # Requirements for the password used to unlock a device.
"maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction.
"passwordExpirationTimeout": "A String", # Password expiration timeout.
"passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction.
"passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX.
"passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordQuality": "A String", # The required password quality.
"passwordScope": "A String", # The scope that the password requirement applies to.
"requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile.
"unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION.
},
],
"appliedPolicyName": "A String", # The name of the policy currently applied to the device.
"appliedPolicyVersion": "A String", # The version of the policy currently applied to the device.
"appliedState": "A String", # The state currently applied to the device.
"commonCriteriaModeInfo": { # 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. # 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 the device is company-owned.
"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled.
"policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification.
},
"deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy.
"adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
"developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device.
"encryptionStatus": "A String", # Encryption status from DevicePolicyManager.
"isDeviceSecure": True or False, # Whether the device is secured with PIN/password.
"isEncrypted": True or False, # Whether the storage encryption is enabled.
"unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled.
"verifyAppsEnabled": True or False, # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced on the device.
},
"disabledReason": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # If the device state is DISABLED, an optional message that is displayed on the device indicating the reason the device is disabled. This field can be modified by a patch request.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
"displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.
{ # Device display information.
"density": 42, # Display density expressed as dots-per-inch.
"displayId": 42, # Unique display id.
"height": 42, # Display height in pixels.
"name": "A String", # Name of the display.
"refreshRate": 42, # Refresh rate of the display in frames per second.
"state": "A String", # State of the display.
"width": 42, # Display width in pixels.
},
],
"dpcMigrationInfo": { # Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC). # Output only. Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC).
"additionalData": "A String", # Output only. If this device was migrated from another DPC, the additionalData field of the migration token is populated here.
"previousDpc": "A String", # Output only. If this device was migrated from another DPC, this is its package name. Not populated otherwise.
},
"enrollmentTime": "A String", # The time of device enrollment.
"enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data.
"enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token.
"hardwareInfo": { # Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy. # Detailed information about the device hardware.
"batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device.
3.14,
],
"batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device.
3.14,
],
"brand": "A String", # Brand of the device. For example, Google.
"cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p.
"enterpriseSpecificId": "A String", # Output only. ID that uniquely identifies a personally-owned device in a particular organization. On the same physical device when enrolled with the same organization, this ID persists across setups and even factory resets. This ID is available on personally-owned devices with a work profile on devices running Android 12 and above.
"gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"hardware": "A String", # Name of the hardware. For example, Angler.
"manufacturer": "A String", # Manufacturer. For example, Motorola.
"model": "A String", # The model of the device. For example, Asus Nexus 7.
"serialNumber": "A String", # The device serial number.
"skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius.
3.14,
],
"skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius.
3.14,
],
},
"hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.
{ # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health.
"batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device.
3.14,
],
"cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device.
3.14,
],
"cpuUsages": [ # CPU usages in percentage for each core available on the device. Usage is 0 for each unplugged core. Empty array implies that CPU usage is not supported in the system.
3.14,
],
"createTime": "A String", # The time the measurements were taken.
"fanSpeeds": [ # Fan speeds in RPM for each fan on the device. Empty array means that there are no fans or fan speed is not supported on the system.
3.14,
],
"gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device.
3.14,
],
"skinTemperatures": [ # Current device skin temperatures in Celsius.
3.14,
],
},
],
"lastPolicyComplianceReportTime": "A String", # Deprecated.
"lastPolicySyncTime": "A String", # The last time the device fetched its policy.
"lastStatusReportTime": "A String", # The last time the device sent a status report.
"managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported.
"memoryEvents": [ # Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy.Events are retained for a certain period of time and old events are deleted.
{ # An event related to memory and storage measurements.To distinguish between new and old events, we recommend using the createTime field.
"byteCount": "A String", # The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"memoryInfo": { # Information about device memory and storage. # Memory information: contains information about device memory and storage.
"totalInternalStorage": "A String", # Total internal storage on device in bytes.
"totalRam": "A String", # Total RAM on device in bytes.
},
"name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
"networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy.
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212.
"meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1.
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
{ # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
"carrierName": "A String", # The carrier name associated with this SIM card.
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
"phoneNumber": "A String", # The phone number associated with this SIM card.
},
],
"wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11.
},
"nonComplianceDetails": [ # Details about policy settings that the device is not compliant with.
{ # Provides detail about non-compliance with a policy setting.
"currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device.
"fieldPath": "A String", # For settings with nested fields, if a particular nested field is out of compliance, this specifies the full path to the offending field. The path is formatted in the same way the policy JSON field would be referenced in JavaScript, that is: 1) For object-typed fields, the field name is followed by a dot then by a subfield name. 2) For array-typed fields, the field name is followed by the array index enclosed in brackets. For example, to indicate a problem with the url field in the externalData field in the 3rd application, the path would be applications[2].externalData.url
"installationFailureReason": "A String", # If package_name is set and the non-compliance reason is APP_NOT_INSTALLED or APP_NOT_UPDATED, the detailed reason the app can't be installed or updated.
"nonComplianceReason": "A String", # The reason the device is not in compliance with the setting.
"packageName": "A String", # The package name indicating which app is out of compliance, if applicable.
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
},
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
"passwordPolicyScope": "A String", # The scope of non-compliant password.
},
},
"specificNonComplianceReason": "A String", # The policy-specific reason the device is not in compliance with the setting.
},
],
"ownership": "A String", # Ownership of the managed device.
"policyCompliant": True or False, # Whether the device is compliant with its policy.
"policyName": "A String", # The name of the policy applied to the device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device's user is applied. This field can be modified by a patch request. You can specify only the policyId when calling enterprises.devices.patch, as long as the policyId doesn’t contain any slashes. The rest of the policy name is inferred.
"powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.
{ # A power management event.
"batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"previousDeviceNames": [ # If the same physical device has been enrolled multiple times, this field contains its previous device names. The serial number is used as the unique identifier to determine if the same physical device has enrolled previously. The names are in chronological order.
"A String",
],
"securityPosture": { # The security posture of the device, as determined by the current device state and the policies applied. # Device's security posture value that reflects how secure the device is.
"devicePosture": "A String", # Device's security posture value.
"postureDetails": [ # Additional details regarding the security posture of the device.
{ # Additional details regarding the security posture of the device.
"advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device.
{ # Provides a user-facing message with locale info. The maximum message length is 4096 characters.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
],
"securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device.
},
],
},
"softwareInfo": { # Information about device software. # Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy.
"androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.
"androidBuildTime": "A String", # Build time.
"androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code.
"androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user.
"androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1.
"bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7.
"deviceBuildSignature": "A String", # SHA-256 hash of android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the system package, which can be used to verify that the system build hasn't been modified.
"deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848.
"primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device.
"securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01.
"systemUpdateInfo": { # Information about a potential pending system update. # Information about a potential pending system update.
"updateReceivedTime": "A String", # The time when the update was first available. A zero value indicates that this field is not set. This field is set only if an update is available (that is, updateStatus is neither UPDATE_STATUS_UNKNOWN nor UP_TO_DATE).
"updateStatus": "A String", # The status of an update: whether an update exists and what type it is.
},
},
"state": "A String", # The state to be applied to the device. This field can be modified by a patch request. Note that when calling enterprises.devices.patch, ACTIVE and DISABLED are the only allowable values. To enter the device into a DELETED state, call enterprises.devices.delete.
"systemProperties": { # Map of selected system properties name and value related to the device. This information is only available if systemPropertiesEnabled is true in the device's policy.
"a_key": "A String",
},
"user": { # A user belonging to an enterprise. # The user who owns the device.
"accountIdentifier": "A String", # A unique identifier you create for this user, such as user342 or asset#44418. This field must be set when the user is created and can't be updated. This field must not contain personally identifiable information (PII). This identifier must be 1024 characters or less; otherwise, the update policy request will fail.
},
"userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.
},
],
"nextPageToken": "A String", # If there are more results, a token to retrieve next page of results.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a device.

Args:
name: string, The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. (required)
body: object, The request body.
The object takes the form of:

{ # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.
"apiLevel": 42, # The API level of the Android platform version running on the device.
"applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy.
{ # Information reported about an installed app.
"applicationSource": "A String", # The source of the package.
"displayName": "A String", # The display name of the app.
"events": [ # The list of app events which have occurred in the last 30 hours.
{ # An app-related event.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # App event type.
},
],
"installerPackageName": "A String", # The package name of the app that installed this app.
"keyedAppStates": [ # List of keyed app states reported by the app.
{ # Keyed app state reported by the app.
"createTime": "A String", # The creation time of the app state on the device.
"data": "A String", # Optionally, a machine-readable value to be read by the EMM. For example, setting values that the admin can choose to query against in the EMM console (e.g. “notify me if the battery_warning data < 10”).
"key": "A String", # The key for the app state. Acts as a point of reference for what the app is providing state for. For example, when providing managed configuration feedback, this key could be the managed configuration key.
"lastUpdateTime": "A String", # The time the app state was most recently updated.
"message": "A String", # Optionally, a free-form message string to explain the app state. If the state was triggered by a particular value (e.g. a managed configuration value), it should be included in the message.
"severity": "A String", # The severity of the app state.
},
],
"packageName": "A String", # Package name of the app.
"packageSha256Hash": "A String", # The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number.
"signingKeyCertFingerprints": [ # The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number.
"A String",
],
"state": "A String", # Application state.
"userFacingType": "A String", # Whether the app is user facing.
"versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another.
"versionName": "A String", # The app version as displayed to the user.
},
],
"appliedPasswordPolicies": [ # The password requirements currently applied to the device. The applied requirements may be slightly different from those specified in passwordPolicies in some cases. fieldPath is set based on passwordPolicies.
{ # Requirements for the password used to unlock a device.
"maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction.
"passwordExpirationTimeout": "A String", # Password expiration timeout.
"passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction.
"passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX.
"passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordQuality": "A String", # The required password quality.
"passwordScope": "A String", # The scope that the password requirement applies to.
"requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile.
"unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION.
},
],
"appliedPolicyName": "A String", # The name of the policy currently applied to the device.
"appliedPolicyVersion": "A String", # The version of the policy currently applied to the device.
"appliedState": "A String", # The state currently applied to the device.
"commonCriteriaModeInfo": { # 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. # 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 the device is company-owned.
"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled.
"policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification.
},
"deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy.
"adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
"developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device.
"encryptionStatus": "A String", # Encryption status from DevicePolicyManager.
"isDeviceSecure": True or False, # Whether the device is secured with PIN/password.
"isEncrypted": True or False, # Whether the storage encryption is enabled.
"unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled.
"verifyAppsEnabled": True or False, # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced on the device.
},
"disabledReason": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # If the device state is DISABLED, an optional message that is displayed on the device indicating the reason the device is disabled. This field can be modified by a patch request.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
"displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.
{ # Device display information.
"density": 42, # Display density expressed as dots-per-inch.
"displayId": 42, # Unique display id.
"height": 42, # Display height in pixels.
"name": "A String", # Name of the display.
"refreshRate": 42, # Refresh rate of the display in frames per second.
"state": "A String", # State of the display.
"width": 42, # Display width in pixels.
},
],
"dpcMigrationInfo": { # Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC). # Output only. Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC).
"additionalData": "A String", # Output only. If this device was migrated from another DPC, the additionalData field of the migration token is populated here.
"previousDpc": "A String", # Output only. If this device was migrated from another DPC, this is its package name. Not populated otherwise.
},
"enrollmentTime": "A String", # The time of device enrollment.
"enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data.
"enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token.
"hardwareInfo": { # Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy. # Detailed information about the device hardware.
"batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device.
3.14,
],
"batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device.
3.14,
],
"brand": "A String", # Brand of the device. For example, Google.
"cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p.
"enterpriseSpecificId": "A String", # Output only. ID that uniquely identifies a personally-owned device in a particular organization. On the same physical device when enrolled with the same organization, this ID persists across setups and even factory resets. This ID is available on personally-owned devices with a work profile on devices running Android 12 and above.
"gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"hardware": "A String", # Name of the hardware. For example, Angler.
"manufacturer": "A String", # Manufacturer. For example, Motorola.
"model": "A String", # The model of the device. For example, Asus Nexus 7.
"serialNumber": "A String", # The device serial number.
"skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius.
3.14,
],
"skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius.
3.14,
],
},
"hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.
{ # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health.
"batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device.
3.14,
],
"cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device.
3.14,
],
"cpuUsages": [ # CPU usages in percentage for each core available on the device. Usage is 0 for each unplugged core. Empty array implies that CPU usage is not supported in the system.
3.14,
],
"createTime": "A String", # The time the measurements were taken.
"fanSpeeds": [ # Fan speeds in RPM for each fan on the device. Empty array means that there are no fans or fan speed is not supported on the system.
3.14,
],
"gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device.
3.14,
],
"skinTemperatures": [ # Current device skin temperatures in Celsius.
3.14,
],
},
],
"lastPolicyComplianceReportTime": "A String", # Deprecated.
"lastPolicySyncTime": "A String", # The last time the device fetched its policy.
"lastStatusReportTime": "A String", # The last time the device sent a status report.
"managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported.
"memoryEvents": [ # Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy.Events are retained for a certain period of time and old events are deleted.
{ # An event related to memory and storage measurements.To distinguish between new and old events, we recommend using the createTime field.
"byteCount": "A String", # The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"memoryInfo": { # Information about device memory and storage. # Memory information: contains information about device memory and storage.
"totalInternalStorage": "A String", # Total internal storage on device in bytes.
"totalRam": "A String", # Total RAM on device in bytes.
},
"name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
"networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy.
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212.
"meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1.
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
{ # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
"carrierName": "A String", # The carrier name associated with this SIM card.
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
"phoneNumber": "A String", # The phone number associated with this SIM card.
},
],
"wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11.
},
"nonComplianceDetails": [ # Details about policy settings that the device is not compliant with.
{ # Provides detail about non-compliance with a policy setting.
"currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device.
"fieldPath": "A String", # For settings with nested fields, if a particular nested field is out of compliance, this specifies the full path to the offending field. The path is formatted in the same way the policy JSON field would be referenced in JavaScript, that is: 1) For object-typed fields, the field name is followed by a dot then by a subfield name. 2) For array-typed fields, the field name is followed by the array index enclosed in brackets. For example, to indicate a problem with the url field in the externalData field in the 3rd application, the path would be applications[2].externalData.url
"installationFailureReason": "A String", # If package_name is set and the non-compliance reason is APP_NOT_INSTALLED or APP_NOT_UPDATED, the detailed reason the app can't be installed or updated.
"nonComplianceReason": "A String", # The reason the device is not in compliance with the setting.
"packageName": "A String", # The package name indicating which app is out of compliance, if applicable.
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
},
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
"passwordPolicyScope": "A String", # The scope of non-compliant password.
},
},
"specificNonComplianceReason": "A String", # The policy-specific reason the device is not in compliance with the setting.
},
],
"ownership": "A String", # Ownership of the managed device.
"policyCompliant": True or False, # Whether the device is compliant with its policy.
"policyName": "A String", # The name of the policy applied to the device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device's user is applied. This field can be modified by a patch request. You can specify only the policyId when calling enterprises.devices.patch, as long as the policyId doesn’t contain any slashes. The rest of the policy name is inferred.
"powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.
{ # A power management event.
"batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"previousDeviceNames": [ # If the same physical device has been enrolled multiple times, this field contains its previous device names. The serial number is used as the unique identifier to determine if the same physical device has enrolled previously. The names are in chronological order.
"A String",
],
"securityPosture": { # The security posture of the device, as determined by the current device state and the policies applied. # Device's security posture value that reflects how secure the device is.
"devicePosture": "A String", # Device's security posture value.
"postureDetails": [ # Additional details regarding the security posture of the device.
{ # Additional details regarding the security posture of the device.
"advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device.
{ # Provides a user-facing message with locale info. The maximum message length is 4096 characters.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
],
"securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device.
},
],
},
"softwareInfo": { # Information about device software. # Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy.
"androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.
"androidBuildTime": "A String", # Build time.
"androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code.
"androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user.
"androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1.
"bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7.
"deviceBuildSignature": "A String", # SHA-256 hash of android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the system package, which can be used to verify that the system build hasn't been modified.
"deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848.
"primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device.
"securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01.
"systemUpdateInfo": { # Information about a potential pending system update. # Information about a potential pending system update.
"updateReceivedTime": "A String", # The time when the update was first available. A zero value indicates that this field is not set. This field is set only if an update is available (that is, updateStatus is neither UPDATE_STATUS_UNKNOWN nor UP_TO_DATE).
"updateStatus": "A String", # The status of an update: whether an update exists and what type it is.
},
},
"state": "A String", # The state to be applied to the device. This field can be modified by a patch request. Note that when calling enterprises.devices.patch, ACTIVE and DISABLED are the only allowable values. To enter the device into a DELETED state, call enterprises.devices.delete.
"systemProperties": { # Map of selected system properties name and value related to the device. This information is only available if systemPropertiesEnabled is true in the device's policy.
"a_key": "A String",
},
"user": { # A user belonging to an enterprise. # The user who owns the device.
"accountIdentifier": "A String", # A unique identifier you create for this user, such as user342 or asset#44418. This field must be set when the user is created and can't be updated. This field must not contain personally identifiable information (PII). This identifier must be 1024 characters or less; otherwise, the update policy request will fail.
},
"userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.
}

updateMask: string, The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.
"apiLevel": 42, # The API level of the Android platform version running on the device.
"applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy.
{ # Information reported about an installed app.
"applicationSource": "A String", # The source of the package.
"displayName": "A String", # The display name of the app.
"events": [ # The list of app events which have occurred in the last 30 hours.
{ # An app-related event.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # App event type.
},
],
"installerPackageName": "A String", # The package name of the app that installed this app.
"keyedAppStates": [ # List of keyed app states reported by the app.
{ # Keyed app state reported by the app.
"createTime": "A String", # The creation time of the app state on the device.
"data": "A String", # Optionally, a machine-readable value to be read by the EMM. For example, setting values that the admin can choose to query against in the EMM console (e.g. “notify me if the battery_warning data < 10”).
"key": "A String", # The key for the app state. Acts as a point of reference for what the app is providing state for. For example, when providing managed configuration feedback, this key could be the managed configuration key.
"lastUpdateTime": "A String", # The time the app state was most recently updated.
"message": "A String", # Optionally, a free-form message string to explain the app state. If the state was triggered by a particular value (e.g. a managed configuration value), it should be included in the message.
"severity": "A String", # The severity of the app state.
},
],
"packageName": "A String", # Package name of the app.
"packageSha256Hash": "A String", # The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number.
"signingKeyCertFingerprints": [ # The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number.
"A String",
],
"state": "A String", # Application state.
"userFacingType": "A String", # Whether the app is user facing.
"versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another.
"versionName": "A String", # The app version as displayed to the user.
},
],
"appliedPasswordPolicies": [ # The password requirements currently applied to the device. The applied requirements may be slightly different from those specified in passwordPolicies in some cases. fieldPath is set based on passwordPolicies.
{ # Requirements for the password used to unlock a device.
"maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction.
"passwordExpirationTimeout": "A String", # Password expiration timeout.
"passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction.
"passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX.
"passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordQuality": "A String", # The required password quality.
"passwordScope": "A String", # The scope that the password requirement applies to.
"requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile.
"unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION.
},
],
"appliedPolicyName": "A String", # The name of the policy currently applied to the device.
"appliedPolicyVersion": "A String", # The version of the policy currently applied to the device.
"appliedState": "A String", # The state currently applied to the device.
"commonCriteriaModeInfo": { # 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. # 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 the device is company-owned.
"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled.
"policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification.
},
"deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy.
"adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
"developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device.
"encryptionStatus": "A String", # Encryption status from DevicePolicyManager.
"isDeviceSecure": True or False, # Whether the device is secured with PIN/password.
"isEncrypted": True or False, # Whether the storage encryption is enabled.
"unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled.
"verifyAppsEnabled": True or False, # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced on the device.
},
"disabledReason": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # If the device state is DISABLED, an optional message that is displayed on the device indicating the reason the device is disabled. This field can be modified by a patch request.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
"displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.
{ # Device display information.
"density": 42, # Display density expressed as dots-per-inch.
"displayId": 42, # Unique display id.
"height": 42, # Display height in pixels.
"name": "A String", # Name of the display.
"refreshRate": 42, # Refresh rate of the display in frames per second.
"state": "A String", # State of the display.
"width": 42, # Display width in pixels.
},
],
"dpcMigrationInfo": { # Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC). # Output only. Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC).
"additionalData": "A String", # Output only. If this device was migrated from another DPC, the additionalData field of the migration token is populated here.
"previousDpc": "A String", # Output only. If this device was migrated from another DPC, this is its package name. Not populated otherwise.
},
"enrollmentTime": "A String", # The time of device enrollment.
"enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data.
"enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token.
"hardwareInfo": { # Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy. # Detailed information about the device hardware.
"batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device.
3.14,
],
"batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device.
3.14,
],
"brand": "A String", # Brand of the device. For example, Google.
"cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p.
"enterpriseSpecificId": "A String", # Output only. ID that uniquely identifies a personally-owned device in a particular organization. On the same physical device when enrolled with the same organization, this ID persists across setups and even factory resets. This ID is available on personally-owned devices with a work profile on devices running Android 12 and above.
"gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"hardware": "A String", # Name of the hardware. For example, Angler.
"manufacturer": "A String", # Manufacturer. For example, Motorola.
"model": "A String", # The model of the device. For example, Asus Nexus 7.
"serialNumber": "A String", # The device serial number.
"skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius.
3.14,
],
"skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius.
3.14,
],
},
"hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.
{ # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health.
"batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device.
3.14,
],
"cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device.
3.14,
],
"cpuUsages": [ # CPU usages in percentage for each core available on the device. Usage is 0 for each unplugged core. Empty array implies that CPU usage is not supported in the system.
3.14,
],
"createTime": "A String", # The time the measurements were taken.
"fanSpeeds": [ # Fan speeds in RPM for each fan on the device. Empty array means that there are no fans or fan speed is not supported on the system.
3.14,
],
"gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device.
3.14,
],
"skinTemperatures": [ # Current device skin temperatures in Celsius.
3.14,
],
},
],
"lastPolicyComplianceReportTime": "A String", # Deprecated.
"lastPolicySyncTime": "A String", # The last time the device fetched its policy.
"lastStatusReportTime": "A String", # The last time the device sent a status report.
"managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported.
"memoryEvents": [ # Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy.Events are retained for a certain period of time and old events are deleted.
{ # An event related to memory and storage measurements.To distinguish between new and old events, we recommend using the createTime field.
"byteCount": "A String", # The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"memoryInfo": { # Information about device memory and storage. # Memory information: contains information about device memory and storage.
"totalInternalStorage": "A String", # Total internal storage on device in bytes.
"totalRam": "A String", # Total RAM on device in bytes.
},
"name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
"networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy.
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212.
"meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1.
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
{ # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
"carrierName": "A String", # The carrier name associated with this SIM card.
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
"phoneNumber": "A String", # The phone number associated with this SIM card.
},
],
"wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11.
},
"nonComplianceDetails": [ # Details about policy settings that the device is not compliant with.
{ # Provides detail about non-compliance with a policy setting.
"currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device.
"fieldPath": "A String", # For settings with nested fields, if a particular nested field is out of compliance, this specifies the full path to the offending field. The path is formatted in the same way the policy JSON field would be referenced in JavaScript, that is: 1) For object-typed fields, the field name is followed by a dot then by a subfield name. 2) For array-typed fields, the field name is followed by the array index enclosed in brackets. For example, to indicate a problem with the url field in the externalData field in the 3rd application, the path would be applications[2].externalData.url
"installationFailureReason": "A String", # If package_name is set and the non-compliance reason is APP_NOT_INSTALLED or APP_NOT_UPDATED, the detailed reason the app can't be installed or updated.
"nonComplianceReason": "A String", # The reason the device is not in compliance with the setting.
"packageName": "A String", # The package name indicating which app is out of compliance, if applicable.
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
},
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
"passwordPolicyScope": "A String", # The scope of non-compliant password.
},
},
"specificNonComplianceReason": "A String", # The policy-specific reason the device is not in compliance with the setting.
},
],
"ownership": "A String", # Ownership of the managed device.
"policyCompliant": True or False, # Whether the device is compliant with its policy.
"policyName": "A String", # The name of the policy applied to the device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device's user is applied. This field can be modified by a patch request. You can specify only the policyId when calling enterprises.devices.patch, as long as the policyId doesn’t contain any slashes. The rest of the policy name is inferred.
"powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.
{ # A power management event.
"batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"previousDeviceNames": [ # If the same physical device has been enrolled multiple times, this field contains its previous device names. The serial number is used as the unique identifier to determine if the same physical device has enrolled previously. The names are in chronological order.
"A String",
],
"securityPosture": { # The security posture of the device, as determined by the current device state and the policies applied. # Device's security posture value that reflects how secure the device is.
"devicePosture": "A String", # Device's security posture value.
"postureDetails": [ # Additional details regarding the security posture of the device.
{ # Additional details regarding the security posture of the device.
"advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device.
{ # Provides a user-facing message with locale info. The maximum message length is 4096 characters.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
],
"securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device.
},
],
},
"softwareInfo": { # Information about device software. # Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy.
"androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.
"androidBuildTime": "A String", # Build time.
"androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code.
"androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user.
"androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1.
"bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7.
"deviceBuildSignature": "A String", # SHA-256 hash of android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the system package, which can be used to verify that the system build hasn't been modified.
"deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848.
"primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device.
"securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01.
"systemUpdateInfo": { # Information about a potential pending system update. # Information about a potential pending system update.
"updateReceivedTime": "A String", # The time when the update was first available. A zero value indicates that this field is not set. This field is set only if an update is available (that is, updateStatus is neither UPDATE_STATUS_UNKNOWN nor UP_TO_DATE).
"updateStatus": "A String", # The status of an update: whether an update exists and what type it is.
},
},
"state": "A String", # The state to be applied to the device. This field can be modified by a patch request. Note that when calling enterprises.devices.patch, ACTIVE and DISABLED are the only allowable values. To enter the device into a DELETED state, call enterprises.devices.delete.
"systemProperties": { # Map of selected system properties name and value related to the device. This information is only available if systemPropertiesEnabled is true in the device's policy.
"a_key": "A String",
},
"user": { # A user belonging to an enterprise. # The user who owns the device.
"accountIdentifier": "A String", # A unique identifier you create for this user, such as user342 or asset#44418. This field must be set when the user is created and can't be updated. This field must not contain personally identifiable information (PII). This identifier must be 1024 characters or less; otherwise, the update policy request will fail.
},
"userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.
}

Android Management API . enterprises . devices

Instance Methods

Method Details