View Source API Reference google_api_android_management v0.57.0
Modules
API client metadata for GoogleApi.AndroidManagement.V1.
API calls for all endpoints tagged Enterprises.
API calls for all endpoints tagged ProvisioningInfo.
API calls for all endpoints tagged SignupUrls.
Handle Tesla connections for GoogleApi.AndroidManagement.V1.
A shell command was issued over ADB via “adb shell command”.
An ADB interactive shell was opened via “adb shell”. Intentionally empty.
Advanced security settings. In most cases, setting these is not needed.
Configuration for an always-on VPN connection.
A compliance rule condition which is satisfied if the Android Framework API level on the device doesn't meet a minimum requirement. There can only be one rule with this type of condition per policy.
Information about a process. It contains process name, start time, app Uid, app Pid, seinfo tag, hash of the base APK.
An app process was started. This is available device-wide on fully managed devices and within the work profile on organization-owned devices with a work profile.
Id to name association of a app track.
This represents a single version of the app.
Information about an app.
An app-related event.
A permission required by the app.
Policy for an individual app. Note: Application availability on a given device cannot be changed using this policy if installAppsDisabled is enabled. The maximum number of applications that you can specify per policy is 3,000.
Information reported about an installed app.
Settings controlling the behavior of application reports.
Batched event logs of events from the device.
An action to block access to apps and data on a fully managed device or in a work profile. This action also triggers a device or work profile to displays a user-facing notification with information (where possible) on how to correct the compliance issue. Note: wipeAction must also be specified.
A new root certificate was installed into the system's trusted credential storage. This is available device-wide on fully managed devices and within the work profile on organization-owned devices with a work profile.
A root certificate was removed from the system's trusted credential storage. This is available device-wide on fully managed devices and within the work profile on organization-owned devices with a work profile.
An X.509v3 certificate failed to validate, currently this validation is performed on the Wi-FI access point and failure may be due to a mismatch upon server certificate validation. However it may in the future include other validation events of an X.509v3 certificate.
Controls apps' access to private keys. The rule determines which private key, if any, Android Device Policy grants to the specified app. Access is granted either when the app calls KeyChain.choosePrivateKeyAlias (https://developer.android.com/reference/android/security/KeyChain#choosePrivateKeyAlias%28android.app.Activity,%20android.security.KeyChainAliasCallback,%20java.lang.String[],%20java.security.Principal[],%20java.lang.String,%20int,%20java.lang.String%29) (or any overloads) to request a private key alias for a given URL, or for rules that are not URL-specific (that is, if urlPattern is not set, or set to the empty string or .*) on Android 11 and above, directly so that the app can call KeyChain.getPrivateKey (https://developer.android.com/reference/android/security/KeyChain#getPrivateKey%28android.content.Context,%20java.lang.String%29), without first having to call KeyChain.choosePrivateKeyAlias.When an app calls KeyChain.choosePrivateKeyAlias if more than one choosePrivateKeyRules matches, the last matching rule defines which key alias to return.
Parameters associated with the CLEAR_APP_DATA command to clear the data of specified apps from the device.
Status of the CLEAR_APP_DATA command to clear the data of specified apps from the device.
A command.
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.
A rule declaring which mitigating actions to take when a device is not compliant with its policy. For every rule, there is always an implicit mitigating action to set policy_compliant to false for the Device resource, and display a message on the device indicating that the device is not compliant with its policy. Other mitigating actions may optionally be taken as well, depending on the field values in the rule.
A TCP connect event was initiated through the standard network stack.
Contact details for managed Google Play enterprises.
This feature is not generally available.
Controls the data from the work profile that can be accessed from the personal profile and vice versa. A nonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile.
Validates whether Android’s built-in cryptographic library (BoringSSL) is valid. Should always succeed on device boot, if it fails, the device should be considered untrusted.
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values. A month and day, with a zero year (for example, an anniversary). A year on its own, with a zero month and a zero day. A year and month, with a zero day (for example, a credit card expiration date).Related types: google.type.TimeOfDay google.type.DateTime google.protobuf.Timestamp
A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.
Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more.
Controls for device radio settings.
Information about security related device settings on device.
Device display information.
Controls for the display settings.
A DNS lookup event was initiated through the standard network stack.
Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC).
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); }
Represents that the device has completed enrollment. User should be in the launcher at this point, device at this point will be compliant and all setup steps have been completed. Intentionally empty.
An enrollment token.
The configuration applied to an enterprise.
Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above.
Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash.
A file was downloaded from the device.
A file was uploaded onto the device.
A system freeze period. When a device’s clock is within the freeze period, all incoming system updates (including security patches) are blocked and won’t be installed.When the device is outside any set freeze periods, the normal policy behavior (automatic, windowed, or postponed) applies.Leap years are ignored in freeze period calculations, in particular: If Feb. 29th is set as the start or end date of a freeze period, the freeze period will start or end on Feb. 28th instead. When a device’s system clock reads Feb. 29th, it’s treated as Feb. 28th. When calculating the number of days in a freeze period or the time between two freeze periods, Feb. 29th is ignored and not counted as a day.Note: For Freeze Periods to take effect, SystemUpdateType cannot be specified as SYSTEM_UPDATE_TYPE_UNSPECIFIED, because freeze periods require a defined policy to be specified.
Contains settings for Google-provided user authentication.
Information about device hardware. The fields related to temperature thresholds are 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.
Amongst apps with InstallType set to: FORCE_INSTALLED PREINSTALLEDthis defines a set of restrictions for the app installation. At least one of the fields must be set. When multiple fields are set, then all the constraints need to be satisfied for the app to be installed.
Response on issuing a command. This is currently empty as a placeholder.
A cryptographic key including user installed, admin installed and system maintained private key is removed from the device either by the user or management. This is available device-wide on fully managed devices and within the work profile on organization-owned devices with a work profile.
A cryptographic key including user installed, admin installed and system maintained private key is installed on the device either by the user or management.This is available device-wide on fully managed devices and within the work profile on organization-owned devices with a work profile.
A cryptographic key including user installed, admin installed and system maintained private key is imported on the device either by the user or management. This is available device-wide on fully managed devices and within the work profile on organization-owned devices with a work profile.
A cryptographic key including user installed, admin installed and system maintained private key is determined to be corrupted due to storage corruption, hardware failure or some OS issue. This is available device-wide on fully managed devices and within the work profile on organization-owned devices with a work profile.
Keyed app state reported by the app.
An attempt was made to unlock the device.
The keyguard was dismissed. Intentionally empty.
The device was locked either by user or timeout. Intentionally empty.
Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK.
An action to launch an app.
Response to a request to list devices for a given enterprise.
Response to a request to list enrollment tokens for a given enterprise.
Response to a request to list enterprises.
Response to a request to list migration tokens for a given enterprise.
The response message for Operations.ListOperations.
Response to a request to list policies for a given enterprise.
Response to a request to list web apps for a given enterprise.
The device location containing the latitude and longitude.
The usageLog buffer on the device has reached 90% of its capacity, therefore older events may be dropped. Intentionally empty.
usageLog policy has been enabled. Intentionally empty.
usageLog policy has been disabled. Intentionally empty.
A lost mode event containing the device location and battery level as a percentage.
An event indicating an outgoing phone call has been made when a device is in lost mode. Intentionally empty.
The managed configurations template for the app, saved from the managed configurations iframe.
Managed property.
An entry of a managed property.
Removable media was mounted.
Removable media was unmounted.
An event related to memory and storage measurements.To distinguish between new and old events, we recommend using the createTime field.
Information about device memory and storage.
A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device. See the guide (https://developers.google.com/android/management/dpc-migration) for more details.
Device network info.
Provides detail about non-compliance with a policy setting.
A compliance rule condition which is satisfied if there exists any matching NonComplianceDetail for the device. A NonComplianceDetail matches a NonComplianceDetailCondition if all the fields which are set within the NonComplianceDetailCondition match the corresponding NonComplianceDetail fields.
This feature is not generally available.
Additional context for non-compliance related to Wi-Fi configuration.
This resource represents a long-running operation that is the result of a network API call.
Device was shutdown. Intentionally empty.
Device was started.
A list of package names.
Additional context for non-compliance related to password policies.
Requirements for the password used to unlock a device.
The result of an attempt to clear the data of a single app.
Configuration for an Android permission and its grant state.
A default activity for handling intents that match a particular intent filter. Note: To set up a kiosk, use InstallType to KIOSK rather than use persistent preferred activities.
Policies for apps in the personal profile of a company-owned device with a work profile.
Policies controlling personal usage on a company-owned device with a work profile.
A policy resource represents a group of settings that govern the behavior of a managed device and the apps installed on it.
A rule that defines the actions to take if a device or work profile is not compliant with the policy specified in settingName. In the case of multiple matching or multiple triggered enforcement rules, a merge will occur with the most severe action being taken. However, all triggered rules are still kept track of: this includes initial trigger time and all associated non-compliance details. In the situation where the most severe enforcement rule is satisfied, the next most appropriate action is applied.
Additional details regarding the security posture of the device.
A power management event.
Information about a device that is available during setup.
Configuration info for an HTTP proxy. For a direct proxy, set the host, port, and excluded_hosts fields. For a PAC script proxy, set the pac_uri field.
The device or profile has been remotely locked via the LOCK command.
Controls for the screen brightness settings.
Controls the screen timeout settings.
The security posture of the device, as determined by the current device state and the policies applied.
An action executed during setup.
A resource containing sign in details for an enterprise. Use enterprises to manage SigninDetails for a given enterprise.For an enterprise, we can have any number of SigninDetails that is uniquely identified by combination of the following three fields (signin_url, allow_personal_usage, token_tag). One cannot create two SigninDetails with the same (signin_url, allow_personal_usage, token_tag). (token_tag is an optional field).Patch: The operation updates the current list of SigninDetails with the new list of SigninDetails. If the stored SigninDetail configuration is passed, it returns the same signin_enrollment_token and qr_code. If we pass multiple identical SigninDetail configurations that are not stored, it will store the first one amongst those SigninDetail configurations. if the configuration already exists we cannot request it more than once in a particular patch API call, otherwise it will give a duplicate key error and the whole operation will fail. If we remove certain SigninDetail configuration from the request then it will get removed from the storage. We can then request another signin_enrollment_token and qr_code for the same SigninDetail configuration.
An enterprise signup URL.
Information about device software.
Additional context for SpecificNonComplianceReason.
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.
Status of the START_LOST_MODE command to put the device into lost mode.
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).
Settings controlling the behavior of status reports.
Parameters associated with the STOP_LOST_MODE command to take the device out of lost mode.
Status of the STOP_LOST_MODE command to take the device out of lost mode.
A lost mode event indicating the user has attempted to stop lost mode.
Configuration for managing system updatesNote: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded but require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details.
Information about a potential pending system update.
Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
A terms and conditions page to be accepted during provisioning.
Controls types of device activity logs collected from the device and reported via Pub/Sub notification (https://developers.google.com/android/management/notifications).
An event logged on the device.
A user belonging to an enterprise.
Provides a user-facing message with locale info. The maximum message length is 4096 characters.
A web app.
An icon for a web app. Supported formats are: png, jpg and webp.
A web token used to access the managed Google Play iframe.
Wi-Fi roaming policy.
Wi-Fi roaming setting.
Represents a Wi-Fi SSID.
Restrictions on which Wi-Fi SSIDs the device can connect to. Note that this does not affect which networks can be configured on the device. Supported on company-owned devices running Android 13 and above.
An action to reset a company owned device or delete a work profile. Note: blockAction must also be specified.
The work profile or company-owned device failed to wipe when requested. This could be user initiated or admin initiated e.g. delete was received. Intentionally empty.