REST Resource: enterprises.policies

  • ThePolicy resource in the Android Management API defines settings for managed devices and their applications.

  • Policies include fields for application management, device restrictions, permissions, networking, system updates, reporting, security, and more.

  • Numerous nested objects and enums provide detailed configurations for specific policy settings, such as app-specific rules, OS updates, compliance requirements, and personal usage management.

  • Policies can manage aspects like app installation behavior, network connectivity, system security features, display settings, and the behavior of applications within work profiles or fully managed devices.

  • Specific policy fields and objects may have minimum Android version requirements, management mode limitations (fully managed or work profile), and deprecation statuses, with non-compliance details reported when these conditions are not met.

Resource: Policy

A policy resource represents a group of settings that govern the behavior of a managed device and the apps installed on it.

JSON representation
{"name":string,"version":string,"applications":[{object (ApplicationPolicy)}],"maximumTimeToLock":string,"screenCaptureDisabled":boolean,"cameraDisabled":boolean,"keyguardDisabledFeatures":[enum (KeyguardDisabledFeature)],"defaultPermissionPolicy":enum (PermissionPolicy),"persistentPreferredActivities":[{object (PersistentPreferredActivity)}],"openNetworkConfiguration":{object},"systemUpdate":{object (SystemUpdate)},"accountTypesWithManagementDisabled":[string],"addUserDisabled":boolean,"adjustVolumeDisabled":boolean,"factoryResetDisabled":boolean,"installAppsDisabled":boolean,"mountPhysicalMediaDisabled":boolean,"modifyAccountsDisabled":boolean,"safeBootDisabled":boolean,"uninstallAppsDisabled":boolean,"statusBarDisabled":boolean,"keyguardDisabled":boolean,"minimumApiLevel":integer,"statusReportingSettings":{object (StatusReportingSettings)},"bluetoothContactSharingDisabled":boolean,"shortSupportMessage":{object (UserFacingMessage)},"longSupportMessage":{object (UserFacingMessage)},"passwordRequirements":{object (PasswordRequirements)},"wifiConfigsLockdownEnabled":boolean,"bluetoothConfigDisabled":boolean,"cellBroadcastsConfigDisabled":boolean,"credentialsConfigDisabled":boolean,"mobileNetworksConfigDisabled":boolean,"tetheringConfigDisabled":boolean,"vpnConfigDisabled":boolean,"wifiConfigDisabled":boolean,"createWindowsDisabled":boolean,"networkResetDisabled":boolean,"outgoingBeamDisabled":boolean,"outgoingCallsDisabled":boolean,"removeUserDisabled":boolean,"shareLocationDisabled":boolean,"smsDisabled":boolean,"unmuteMicrophoneDisabled":boolean,"usbFileTransferDisabled":boolean,"ensureVerifyAppsEnabled":boolean,"permittedInputMethods":{object (PackageNameList)},"stayOnPluggedModes":[enum (BatteryPluggedMode)],"recommendedGlobalProxy":{object (ProxyInfo)},"setUserIconDisabled":boolean,"setWallpaperDisabled":boolean,"choosePrivateKeyRules":[{object (ChoosePrivateKeyRule)}],"alwaysOnVpnPackage":{object (AlwaysOnVpnPackage)},"frpAdminEmails":[string],"deviceOwnerLockScreenInfo":{object (UserFacingMessage)},"dataRoamingDisabled":boolean,"locationMode":enum (LocationMode),"networkEscapeHatchEnabled":boolean,"bluetoothDisabled":boolean,"complianceRules":[{object (ComplianceRule)}],"blockApplicationsEnabled":boolean,"installUnknownSourcesAllowed":boolean,"debuggingFeaturesAllowed":boolean,"funDisabled":boolean,"autoTimeRequired":boolean,"permittedAccessibilityServices":{object (PackageNameList)},"appAutoUpdatePolicy":enum (AppAutoUpdatePolicy),"kioskCustomLauncherEnabled":boolean,"androidDevicePolicyTracks":[enum (AppTrack)],"skipFirstUseHintsEnabled":boolean,"privateKeySelectionEnabled":boolean,"encryptionPolicy":enum (EncryptionPolicy),"usbMassStorageEnabled":boolean,"permissionGrants":[{object (PermissionGrant)}],"playStoreMode":enum (PlayStoreMode),"setupActions":[{object (SetupAction)}],"passwordPolicies":[{object (PasswordRequirements)}],"policyEnforcementRules":[{object (PolicyEnforcementRule)}],"kioskCustomization":{object (KioskCustomization)},"advancedSecurityOverrides":{object (AdvancedSecurityOverrides)},"personalUsagePolicies":{object (PersonalUsagePolicies)},"autoDateAndTimeZone":enum (AutoDateAndTimeZone),"oncCertificateProviders":[{object (OncCertificateProvider)}],"crossProfilePolicies":{object (CrossProfilePolicies)},"preferentialNetworkService":enum (PreferentialNetworkService),"usageLog":{object (UsageLog)},"cameraAccess":enum (CameraAccess),"microphoneAccess":enum (MicrophoneAccess),"deviceConnectivityManagement":{object (DeviceConnectivityManagement)},"deviceRadioState":{object (DeviceRadioState)},"credentialProviderPolicyDefault":enum (CredentialProviderPolicyDefault),"printingPolicy":enum (PrintingPolicy),"displaySettings":{object (DisplaySettings)},"assistContentPolicy":enum (AssistContentPolicy),"workAccountSetupConfig":{object (WorkAccountSetupConfig)},"wipeDataFlags":[enum (WipeDataFlag)],"enterpriseDisplayNameVisibility":enum (EnterpriseDisplayNameVisibility),"appFunctions":enum (AppFunctions),"defaultApplicationSettings":[{object (DefaultApplicationSetting)}]}
Fields
name

string

The name of the policy in the formenterprises/{enterpriseId}/policies/{policyId}.

version

string (int64 format)

The version of the policy. This is a read-only field. The version is incremented each time the policy is updated.

applications[]

object (ApplicationPolicy)

Policy applied to apps. This can have at most 3,000 elements.

maximumTimeToLock

string (int64 format)

Maximum time in milliseconds for user activity until the device locks. A value of 0 means there is no restriction.

screenCaptureDisabled

boolean

Whether screen capture is disabled.

cameraDisabled
(deprecated)

boolean

UsecameraAccess instead.

IfcameraAccess is set to any value other thanCAMERA_ACCESS_UNSPECIFIED, this has no effect. Otherwise this field controls whether cameras are disabled: If true, all cameras are disabled, otherwise they are available. For fully managed devices this field applies for all apps on the device. For work profiles, this field applies only to apps in the work profile, and the camera access of apps outside the work profile is unaffected.

keyguardDisabledFeatures[]

enum (KeyguardDisabledFeature)

Disabled keyguard customizations, such as widgets.

defaultPermissionPolicy

enum (PermissionPolicy)

The default permission policy for runtime permission requests.

persistentPreferredActivities[]

object (PersistentPreferredActivity)

Default intent handler activities.

openNetworkConfiguration

object (Struct format)

Network configuration for the device. Seeconfigure networks for more information.

systemUpdate

object (SystemUpdate)

The system update policy, which controls how OS updates are applied. If the update type isWINDOWED, the update window will automatically apply to Play app updates as well.

Note:Google Play system updates (also called Mainline updates) are automatically downloaded and require a device reboot to be installed. Refer to the mainline section inManage system updates for further details.

accountTypesWithManagementDisabled[]

string

Account types that can't be managed by the user.

addUserDisabled

boolean

Whether adding new users and profiles is disabled. For devices wheremanagementMode isDEVICE_OWNER this field is ignored and the user is never allowed to add or remove users.

adjustVolumeDisabled

boolean

Whether adjusting the master volume is disabled. Also mutes the device. The setting has effect only on fully managed devices.

factoryResetDisabled

boolean

Whether factory resetting from settings is disabled.

installAppsDisabled

boolean

Whether user installation of apps is disabled.

mountPhysicalMediaDisabled

boolean

Whether the user mounting physical external media is disabled.

modifyAccountsDisabled

boolean

Whether adding or removing accounts is disabled.

safeBootDisabled
(deprecated)

boolean

safeBootDisabled is deprecated. Please useadvancedSecurityOverrides.developerSettings instead.

Whether rebooting the device into safe boot is disabled.

uninstallAppsDisabled

boolean

Whether user uninstallation of applications is disabled. This prevents apps from being uninstalled, even those removed usingapplications

statusBarDisabled
(deprecated)

boolean

This item is deprecated!

Whether the status bar is disabled. This disables notifications, quick settings, and other screen overlays that allow escape from full-screen mode. DEPRECATED. To disable the status bar on a kiosk device, useInstallTypeKIOSK orkioskCustomLauncherEnabled.

keyguardDisabled

boolean

If true, this disables theLock Screen for primary and/or secondary displays. This policy is supported only in dedicated device management mode.

minimumApiLevel

integer

The minimum allowed Android API level.

statusReportingSettings

object (StatusReportingSettings)

Status reporting settings

bluetoothContactSharingDisabled

boolean

Whether bluetooth contact sharing is disabled.

shortSupportMessage

object (UserFacingMessage)

A message displayed to the user in the settings screen wherever functionality has been disabled by the admin. If the message is longer than 200 characters it may be truncated.

longSupportMessage

object (UserFacingMessage)

A message displayed to the user in the device administators settings screen.

passwordRequirements
(deprecated)

object (PasswordRequirements)

This item is deprecated!

Password requirements. The fieldpasswordRequirements.require_password_unlock must not be set. DEPRECATED - UsepasswordPolicies.

Note:

Complexity-based values ofPasswordQuality, that is,COMPLEXITY_LOW,COMPLEXITY_MEDIUM, andCOMPLEXITY_HIGH, cannot be used here.unifiedLockSettings cannot be used here.

wifiConfigsLockdownEnabled
(deprecated)

boolean

Please usedeviceConnectivityManagement.configureWifi instead.

This is deprecated.

bluetoothConfigDisabled

boolean

Whether configuring bluetooth is disabled.

cellBroadcastsConfigDisabled

boolean

Whether configuring cell broadcast is disabled.

credentialsConfigDisabled

boolean

Whether configuring user credentials is disabled.

mobileNetworksConfigDisabled

boolean

Whether configuring mobile networks is disabled.

tetheringConfigDisabled
(deprecated)

boolean

Please usedeviceConnectivityManagement.tetheringSettings instead.

Whether configuring tethering and portable hotspots is disabled. IftetheringSettings is set to anything other thanTETHERING_SETTINGS_UNSPECIFIED, this setting is ignored.

vpnConfigDisabled

boolean

Whether configuring VPN is disabled.

wifiConfigDisabled
(deprecated)

boolean

Please usedeviceConnectivityManagement.configureWifi instead.

Whether configuring Wi-Fi networks is disabled. Supported on fully managed devices and work profiles on company-owned devices. For fully managed devices, setting this to true removes all configured networks and retains only the networks configured usingopenNetworkConfiguration. For work profiles on company-owned devices, existing configured networks are not affected and the user is not allowed to add, remove, or modify Wi-Fi networks. IfconfigureWifi is set to anything other thanCONFIGURE_WIFI_UNSPECIFIED, this setting is ignored.Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (seenetworkEscapeHatchEnabled).

createWindowsDisabled

boolean

Whether creating windows besides app windows is disabled.

networkResetDisabled

boolean

Whether resetting network settings is disabled.

outgoingBeamDisabled

boolean

Whether using NFC to beam data from apps is disabled.

outgoingCallsDisabled

boolean

Whether outgoing calls are disabled.

removeUserDisabled

boolean

Whether removing other users is disabled.

shareLocationDisabled

boolean

Whether location sharing is disabled.

smsDisabled

boolean

Whether sending and receiving SMS messages is disabled.

unmuteMicrophoneDisabled
(deprecated)

boolean

UsemicrophoneAccess instead.

IfmicrophoneAccess is set to any value other thanMICROPHONE_ACCESS_UNSPECIFIED, this has no effect. Otherwise this field controls whether microphones are disabled: If true, all microphones are disabled, otherwise they are available. This is available only on fully managed devices.

usbFileTransferDisabled
(deprecated)

boolean

usbFileTransferDisabled is deprecated. Please usedeviceConnectivityManagement.usbDataAccess instead.

Whether transferring files over USB is disabled. This is supported only on company-owned devices.

ensureVerifyAppsEnabled
(deprecated)

boolean

ensureVerifyAppsEnabled is deprecated. Please useadvancedSecurityOverrides.googlePlayProtectVerifyApps instead.

Whether app verification is force-enabled.

permittedInputMethods

object (PackageNameList)

If present, only the input methods provided by packages in this list are permitted. If this field is present, but the list is empty, then only system input methods are permitted.

stayOnPluggedModes[]

enum (BatteryPluggedMode)

The battery plugged in modes for which the device stays on. When using this setting, it is recommended to clearmaximumTimeToLock so that the device doesn't lock itself while it stays on.

recommendedGlobalProxy

object (ProxyInfo)

The network-independent global HTTP proxy. Typically proxies should be configured per-network inopenNetworkConfiguration. However for unusual configurations like general internal filtering a global HTTP proxy may be useful. If the proxy is not accessible, network access may break. The global proxy is only a recommendation and some apps may ignore it.

setUserIconDisabled

boolean

Whether changing the user icon is disabled. This applies only on devices running Android 7 and above.

setWallpaperDisabled

boolean

Whether changing the wallpaper is disabled.

choosePrivateKeyRules[]

object (ChoosePrivateKeyRule)

Rules for determining apps' access to private keys. SeeChoosePrivateKeyRule for details. This must be empty if any application hasCERT_SELECTION delegation scope.

alwaysOnVpnPackage

object (AlwaysOnVpnPackage)

Configuration for an always-on VPN connection. Use withvpnConfigDisabled to prevent modification of this setting.

frpAdminEmails[]

string

Email addresses of device administrators for factory reset protection. When the device is factory reset, it will require one of these admins to log in with the Google account email and password to unlock the device. If no admins are specified, the device won't provide factory reset protection.

deviceOwnerLockScreenInfo

object (UserFacingMessage)

The device owner information to be shown on the lock screen.

dataRoamingDisabled

boolean

Whether roaming data services are disabled.

locationMode

enum (LocationMode)

The degree of location detection enabled.

networkEscapeHatchEnabled

boolean

Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings.

Note: SettingwifiConfigDisabled to true will override this setting under specific circumstances. Please seewifiConfigDisabled for further details. SettingconfigureWifi toDISALLOW_CONFIGURING_WIFI will override this setting under specific circumstances. Please seeDISALLOW_CONFIGURING_WIFI for further details.

bluetoothDisabled

boolean

Whether bluetooth is disabled. Prefer this setting overbluetoothConfigDisabled becausebluetoothConfigDisabled can be bypassed by the user.

complianceRules[]
(deprecated)

object (ComplianceRule)

This item is deprecated!

Rules declaring which mitigating actions to take when a device is not compliant with its policy. When the conditions for multiple rules are satisfied, all of the mitigating actions for the rules are taken. There is a maximum limit of 100 rules. Use policy enforcement rules instead.

blockApplicationsEnabled
(deprecated)

boolean

This item is deprecated!

Whether applications other than the ones configured inapplications are blocked from being installed. When set, applications that were installed under a previous policy but no longer appear in the policy are automatically uninstalled.

installUnknownSourcesAllowed
(deprecated)

boolean

installUnknownSourcesAllowed is deprecated. This field has no effect - please useadvancedSecurityOverrides.untrustedAppsPolicy instead.

This field has no effect.

debuggingFeaturesAllowed
(deprecated)

boolean

debuggingFeaturesAllowed is deprecated. Please useadvancedSecurityOverrides.developerSettings instead.

Whether the user is allowed to enable debugging features.

funDisabled

boolean

Whether the user is allowed to have fun. Controls whether the Easter egg game in Settings is disabled.

autoTimeRequired
(deprecated)

boolean

UseautoDateAndTimeZone instead.

Whether auto time is required, which prevents the user from manually setting the date and time. IfautoDateAndTimeZone is set, this field is ignored.

permittedAccessibilityServices

object (PackageNameList)

Specifies permitted accessibility services. If the field is not set, any accessibility service can be used. If the field is set, only the accessibility services in this list and the system's built-in accessibility service can be used. In particular, if the field is set to empty, only the system's built-in accessibility servicess can be used. This can be set on fully managed devices and on work profiles. When applied to a work profile, this affects both the personal profile and the work profile.

appAutoUpdatePolicy

enum (AppAutoUpdatePolicy)

Recommended alternative:autoUpdateMode which is set per app, provides greater flexibility around update frequency.

WhenautoUpdateMode is set toAUTO_UPDATE_POSTPONED orAUTO_UPDATE_HIGH_PRIORITY, this field has no effect.

The app auto update policy, which controls when automatic app updates can be applied.

kioskCustomLauncherEnabled

boolean

Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via theapplications setting. Apps appear on a single page in alphabetical order. UsekioskCustomization to further configure the kiosk device behavior.

androidDevicePolicyTracks[]
(deprecated)

enum (AppTrack)

This setting is not supported.

This setting is not supported. Any value is ignored.

skipFirstUseHintsEnabled

boolean

Flag to skip hints on the first use. Enterprise admin can enable the system recommendation for apps to skip their user tutorial and other introductory hints on first start-up.

privateKeySelectionEnabled

boolean

Allows showing UI on a device for a user to choose a private key alias if there are no matching rules in ChoosePrivateKeyRules. For devices below Android P, setting this may leave enterprise keys vulnerable. This value will have no effect if any application hasCERT_SELECTION delegation scope.

encryptionPolicy

enum (EncryptionPolicy)

Whether encryption is enabled

usbMassStorageEnabled
(deprecated)

boolean

This item is deprecated!

Whether USB storage is enabled. Deprecated.

permissionGrants[]

object (PermissionGrant)

Explicit permission or group grants or denials for all apps. These values override thedefaultPermissionPolicy.

playStoreMode

enum (PlayStoreMode)

This mode controls which apps are available to the user in the Play Store and the behavior on the device when apps are removed from the policy.

setupActions[]

object (SetupAction)

Action to take during the setup process. At most one action may be specified.

passwordPolicies[]

object (PasswordRequirements)

Password requirement policies. Different policies can be set for work profile or fully managed devices by setting thepasswordScope field in the policy.

policyEnforcementRules[]

object (PolicyEnforcementRule)

Rules that define the behavior when a particular policy can not be applied on device

kioskCustomization

object (KioskCustomization)

Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, setkioskCustomLauncherEnabled totrue or specify an app in the policy withinstallTypeKIOSK.

advancedSecurityOverrides

object (AdvancedSecurityOverrides)

Advanced security settings. In most cases, setting these is not needed.

personalUsagePolicies

object (PersonalUsagePolicies)

Policies managing personal usage on a company-owned device.

autoDateAndTimeZone

enum (AutoDateAndTimeZone)

Whether auto date, time, and time zone are enabled on a company-owned device. If this is set, thenautoTimeRequired is ignored.

oncCertificateProviders[]

object (OncCertificateProvider)

This feature is not generally available.

crossProfilePolicies

object (CrossProfilePolicies)

Cross-profile policies applied on the device.

preferentialNetworkService

enum (PreferentialNetworkService)

Controls whether preferential network service is enabled on the work profile or on fully managed devices. For example, an organization may have an agreement with a carrier that all of the work data from its employees' devices will be sent via a network service dedicated for enterprise use. An example of a supported preferential network service is the enterprise slice on 5G networks. This policy has no effect ifpreferentialNetworkServiceSettings orApplicationPolicy.preferentialNetworkId is set on devices running Android 13 or above.

usageLog

object (UsageLog)

Configuration of device activity logging.

cameraAccess

enum (CameraAccess)

Controls the use of the camera and whether the user has access to the camera access toggle.

microphoneAccess

enum (MicrophoneAccess)

Controls the use of the microphone and whether the user has access to the microphone access toggle. This applies only on fully managed devices.

deviceConnectivityManagement

object (DeviceConnectivityManagement)

Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more.

deviceRadioState

object (DeviceRadioState)

Covers controls for radio state such as Wi-Fi, bluetooth, and more.

credentialProviderPolicyDefault

enum (CredentialProviderPolicyDefault)

Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, seethis andthis for details. See alsocredentialProviderPolicy.

printingPolicy

enum (PrintingPolicy)

Optional. Controls whether printing is allowed. This is supported on devices running Android 9 and above. .

displaySettings

object (DisplaySettings)

Optional. Controls for the display settings.

assistContentPolicy

enum (AssistContentPolicy)

Optional. Controls whetherAssistContent is allowed to be sent to a privileged app such as an assistant app. AssistContent includes screenshots and information about an app, such as package name. This is supported on Android 15 and above.

workAccountSetupConfig

object (WorkAccountSetupConfig)

Optional. Controls the work account setup configuration, such as details of whether a Google authenticated account is required.

wipeDataFlags[]

enum (WipeDataFlag)

Optional. Wipe flags to indicate what data is wiped when a device or profile wipe is triggered due to any reason (for example, non-compliance). This does not apply to theenterprises.devices.delete method. . This list must not have duplicates.

enterpriseDisplayNameVisibility

enum (EnterpriseDisplayNameVisibility)

Optional. Controls whether theenterpriseDisplayName is visible on the device (e.g. lock screen message on company-owned devices).

appFunctions

enum (AppFunctions)

Optional. Controls whether apps on the device for fully managed devices or in the work profile for devices with work profiles are allowed to expose app functions.

defaultApplicationSettings[]

object (DefaultApplicationSetting)

Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changingany default applications on that profile.

Only oneDefaultApplicationSetting is allowed for eachDefaultApplicationType.

SeeDefault application settings guide for more details.

ApplicationPolicy

Policy for an individual app. Note: Application availability on a given device cannot be changed using this policy ifinstallAppsDisabled is enabled. The maximum number of applications that you can specify per policy is 3,000.

JSON representation
{"packageName":string,"installType":enum (InstallType),"lockTaskAllowed":boolean,"defaultPermissionPolicy":enum (PermissionPolicy),"permissionGrants":[{object (PermissionGrant)}],"managedConfiguration":{object},"disabled":boolean,"minimumVersionCode":integer,"delegatedScopes":[enum (DelegatedScope)],"managedConfigurationTemplate":{object (ManagedConfigurationTemplate)},"accessibleTrackIds":[string],"connectedWorkAndPersonalApp":enum (ConnectedWorkAndPersonalApp),"autoUpdateMode":enum (AutoUpdateMode),"extensionConfig":{object (ExtensionConfig)},"alwaysOnVpnLockdownExemption":enum (AlwaysOnVpnLockdownExemption),"workProfileWidgets":enum (WorkProfileWidgets),"credentialProviderPolicy":enum (CredentialProviderPolicy),"customAppConfig":{object (CustomAppConfig)},"installConstraint":[{object (InstallConstraint)}],"installPriority":integer,"userControlSettings":enum (UserControlSettings),"preferentialNetworkId":enum (PreferentialNetworkId),"signingKeyCerts":[{object (ApplicationSigningKeyCert)}],"roles":[{object (Role)}]}
Fields
packageName

string

The package name of the app. For example,com.google.android.youtube for the YouTube app.

installType

enum (InstallType)

The type of installation to perform.

lockTaskAllowed
(deprecated)

boolean

This item is deprecated!

Whether the app is allowed to lock itself in full-screen mode. DEPRECATED. UseInstallTypeKIOSK orkioskCustomLauncherEnabled to configure a dedicated device.

defaultPermissionPolicy

enum (PermissionPolicy)

The default policy for all permissions requested by the app. If specified, this overrides the policy-leveldefaultPermissionPolicy which applies to all apps. It does not override thepermissionGrants which applies to all apps.

permissionGrants[]

object (PermissionGrant)

Explicit permission grants or denials for the app. These values override thedefaultPermissionPolicy andpermissionGrants which apply to all apps.

managedConfiguration

object (Struct format)

Managed configuration applied to the app. The format for the configuration is dictated by theManagedProperty values supported by the app. Each field name in the managed configuration must match thekey field of theManagedProperty. The field value must be compatible with thetype of theManagedProperty:

typeJSON value
BOOLtrue orfalse
STRINGstring
INTEGERnumber
CHOICEstring
MULTISELECTarray of strings
HIDDENstring
BUNDLE_ARRAYarray of objects

disabled

boolean

Whether the app is disabled. When disabled, the app data is still preserved.

minimumVersionCode

integer

The minimum version of the app that runs on the device. If set, the device attempts to update the app to at least this version code. If the app is not up-to-date, the device will contain aNonComplianceDetail withnonComplianceReason set toAPP_NOT_UPDATED. The app must already be published to Google Play with a version code greater than or equal to this value. At most 20 apps may specify a minimum version code per policy.

delegatedScopes[]

enum (DelegatedScope)

The scopes delegated to the app from Android Device Policy. These provide additional privileges for the applications they are applied to.

managedConfigurationTemplate

object (ManagedConfigurationTemplate)

The managed configurations template for the app, saved from themanaged configurations iframe. This field is ignored if managedConfiguration is set.

accessibleTrackIds[]

string

List of the app’s track IDs that a device belonging to the enterprise can access. If the list contains multiple track IDs, devices receive the latest version among all accessible tracks. If the list contains no track IDs, devices only have access to the app’s production track. More details about each track are available inAppTrackInfo.

connectedWorkAndPersonalApp

enum (ConnectedWorkAndPersonalApp)

Controls whether the app can communicate with itself across a device’s work and personal profiles, subject to user consent.

autoUpdateMode

enum (AutoUpdateMode)

Controls the auto-update mode for the app.

extensionConfig
(deprecated)

object (ExtensionConfig)

extensionConfig is deprecated - useCOMPANION_APP role instead.

Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.

This field can be set for at most one app. If there is any app withCOMPANION_APP role, this field cannot be set.

The signing key certificate fingerprint of the app on the device must match one of the entries inApplicationPolicy.signingKeyCerts orExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and ifApplicationPolicy.signingKeyCerts andExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, aNonComplianceDetail withINVALID_VALUE is reported.

alwaysOnVpnLockdownExemption

enum (AlwaysOnVpnLockdownExemption)

Specifies whether the app is allowed networking when the VPN is not connected andalwaysOnVpnPackage.lockdownEnabled is enabled. If set toVPN_LOCKDOWN_ENFORCED, the app is not allowed networking, and if set toVPN_LOCKDOWN_EXEMPTION, the app is allowed networking. Only supported on devices running Android 10 and above. If this is not supported by the device, the device will contain aNonComplianceDetail withnonComplianceReason set toAPI_LEVEL and a fieldPath. If this is not applicable to the app, the device will contain aNonComplianceDetail withnonComplianceReason set toUNSUPPORTED and a fieldPath. The fieldPath is set toapplications[i].alwaysOnVpnLockdownExemption, wherei is the index of the package in theapplications policy.

workProfileWidgets

enum (WorkProfileWidgets)

Specifies whether the app installed in the work profile is allowed to add widgets to the home screen.

credentialProviderPolicy

enum (CredentialProviderPolicy)

Optional. Whether the app is allowed to act as a credential provider on Android 14 and above.

customAppConfig

object (CustomAppConfig)

Optional. Configuration for this custom app.

installType must be set toCUSTOM for this to be set.

installConstraint[]

object (InstallConstraint)

Optional. The constraints for installing the app. You can specify a maximum of oneInstallConstraint. Multiple constraints are rejected.

installPriority

integer

Optional. Amongst apps withinstallType set to:

this controls the relative priority of installation. A value of 0 (default) means this app has no priority over other apps. For values between 1 and 10,000, a lower value means a higher priority. Values outside of the range 0 to 10,000 inclusive are rejected.

userControlSettings

enum (UserControlSettings)

Optional. Specifies whether user control is permitted for the app. User control includes user actions like force-stopping and clearing app data. Certain types of apps have special treatment, seeUSER_CONTROL_SETTINGS_UNSPECIFIED andUSER_CONTROL_ALLOWED for more details.

preferentialNetworkId

enum (PreferentialNetworkId)

Optional. ID of the preferential network the application uses. There must be a configuration for the specified network ID inpreferentialNetworkServiceConfigs. If set toPREFERENTIAL_NETWORK_ID_UNSPECIFIED, the application will use the default network ID specified indefaultPreferentialNetworkId. See the documentation ofdefaultPreferentialNetworkId for the list of apps excluded from this defaulting. This applies on both work profiles and fully managed devices on Android 13 and above.

signingKeyCerts[]

object (ApplicationSigningKeyCert)

Optional. Signing key certificates of the app.

This field is required in the following cases:

If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, aNonComplianceDetail withINVALID_VALUE is reported.

For other cases, this field is optional and the signing key certificates obtained from Play Store are used.

See following policy settings to see how this field is used:

roles[]

object (Role)

Optional. Roles the app has.

Apps having certain roles can be exempted from power and background execution restrictions, suspension and hibernation on Android 14 and above. The user control can also be disallowed for apps with certain roles on Android 11 and above. Refer to the documentation of eachRoleType for more details.

The app is notified about the roles that are set for it if the app has a notification receiver service with<meta-data android:name="com.google.android.managementapi.notification.NotificationReceiverService.SERVICE_APP_ROLES" android:value="" />. The app is notified whenever its roles are updated or after the app is installed when it has nonempty list of roles. The app can use this notification to bootstrap itself after the installation. SeeIntegrate with the AMAPI SDK andManage app roles guides for more details on the requirements for the service.

For the exemptions to be applied and the app to be notified about the roles, the signing key certificate fingerprint of the app on the device must match one of the signing key certificate fingerprints obtained from Play Store or one of the entries inApplicationPolicy.signingKeyCerts. Otherwise, aNonComplianceDetail withAPP_SIGNING_CERT_MISMATCH is reported.

There must not be duplicate roles with the sameroleType. Multiple apps cannot hold a role with the sameroleType. A role with typeROLE_TYPE_UNSPECIFIED is not allowed.

InstallType

The type of installation to perform for an app. IfsetupAction references an app, they must haveinstallType set asREQUIRED_FOR_SETUP or the setup will fail.

Enums
INSTALL_TYPE_UNSPECIFIEDUnspecified. Defaults to AVAILABLE.
PREINSTALLEDThe app is automatically installed and can be removed by the user.
FORCE_INSTALLEDThe app is automatically installed regardless of a set maintenance window and can't be removed by the user.
BLOCKEDThe app is blocked and can't be installed. If the app was installed under a previous policy, it will be uninstalled. This also blocks its instant app functionality.
AVAILABLEThe app is available to install.
REQUIRED_FOR_SETUPThe app is automatically installed and can't be removed by the user and will prevent setup from completion until installation is complete.
KIOSK

The app is automatically installed in kiosk mode: it's set as the preferred home intent and whitelisted for lock task mode. Device setup won't complete until the app is installed. After installation, users won't be able to remove the app. You can only set thisinstallType for one app per policy. When this is present in the policy, status bar will be automatically disabled.

If there is any app withKIOSK role, then this install type cannot be set for any app.

KIOSK install type is deprecated - useREQUIRED_FOR_SETUP orCUSTOM depending on the use case and useKIOSK role instead.

CUSTOM

The app can only be installed and updated viaAMAPI SDK command.

Note:

PermissionPolicy

The policy for granting permission requests to apps.

Enums
PERMISSION_POLICY_UNSPECIFIEDPolicy not specified. If no policy is specified for a permission at any level, then thePROMPT behavior is used by default.
PROMPTPrompt the user to grant a permission.
GRANT

Automatically grant a permission.

On Android 12 and above,READ_SMS and following sensor-related permissions can only be granted on fully managed devices:

DENYAutomatically deny a permission.

PermissionGrant

Configuration for an Android permission and its grant state.

JSON representation
{"permission":string,"policy":enum (PermissionPolicy)}
Fields
permission

string

The Android permission or group, e.g.android.permission.READ_CALENDAR orandroid.permission_group.CALENDAR.

policy

enum (PermissionPolicy)

The policy for granting the permission.

DelegatedScope

Delegation Scopes that another package can acquire from Android Device Policy. These provide additional privileges for the applications they are applied to.

Enums
DELEGATED_SCOPE_UNSPECIFIEDNo delegation scope specified.
CERT_INSTALLGrants access to certificate installation and management. This scope can be delegated to multiple applications.
MANAGED_CONFIGURATIONSGrants access to managed configurations management. This scope can be delegated to multiple applications.
BLOCK_UNINSTALLGrants access to blocking uninstallation. This scope can be delegated to multiple applications.
PERMISSION_GRANTGrants access to permission policy and permission grant state. This scope can be delegated to multiple applications.
PACKAGE_ACCESSGrants access to package access state. This scope can be delegated to multiple applications.
ENABLE_SYSTEM_APPGrants access for enabling system apps. This scope can be delegated to multiple applications.
NETWORK_ACTIVITY_LOGSGrants access to network activity logs. Allows the delegated application to callsetNetworkLoggingEnabled,isNetworkLoggingEnabled andretrieveNetworkLogs methods. This scope can be delegated to at most one application. Supported for fully managed devices on Android 10 and above. Supported for a work profile on Android 12 and above. When delegation is supported and set,NETWORK_ACTIVITY_LOGS is ignored.
SECURITY_LOGSGrants access to security logs. Allows the delegated application to callsetSecurityLoggingEnabled,isSecurityLoggingEnabled,retrieveSecurityLogs andretrievePreRebootSecurityLogs methods. This scope can be delegated to at most one application. Supported for fully managed devices and company-owned devices with a work profile on Android 12 and above. When delegation is supported and set,SECURITY_LOGS is ignored.
CERT_SELECTIONGrants access to selection of KeyChain certificates on behalf of requesting apps. Once granted, the delegated application will start receivingDelegatedAdminReceiver#onChoosePrivateKeyAlias. Allows the delegated application to callgrantKeyPairToApp andrevokeKeyPairFromApp methods. This scope can be delegated to at most one application.choosePrivateKeyRules must be empty andprivateKeySelectionEnabled has no effect if certificate selection is delegated to an application.

ManagedConfigurationTemplate

The managed configurations template for the app, saved from themanaged configurations iframe.

JSON representation
{"templateId":string,"configurationVariables":{string:string,...}}
Fields
templateId

string

The ID of the managed configurations template.

configurationVariables

map (key: string, value: string)

Optional, a map containing <key, value> configuration variables defined for the configuration.

An object containing a list of"key": value pairs. Example:{ "name": "wrench", "mass": "1.3kg", "count": "3" }.

ConnectedWorkAndPersonalApp

Controls whether the app can communicate with itself cross-profile, subject to user consent.

Enums
CONNECTED_WORK_AND_PERSONAL_APP_UNSPECIFIEDUnspecified. Defaults to CONNECTED_WORK_AND_PERSONAL_APPS_DISALLOWED.
CONNECTED_WORK_AND_PERSONAL_APP_DISALLOWEDDefault. Prevents the app from communicating cross-profile.
CONNECTED_WORK_AND_PERSONAL_APP_ALLOWEDAllows the app to communicate across profiles after receiving user consent.

AutoUpdateMode

Controls the auto-update mode for the app. If a device user makes changes to the device settings manually, these choices are ignored byAutoUpdateMode as it takes precedence.

Enums
AUTO_UPDATE_MODE_UNSPECIFIEDUnspecified. Defaults toAUTO_UPDATE_DEFAULT.
AUTO_UPDATE_DEFAULT

The default update mode.

The app is automatically updated with low priority to minimize the impact on the user.

The app is updated when all of the following constraints are met:

  • The device is not actively used.
  • The device is connected to an unmetered network.
  • The device is charging.
  • The app to be updated is not running in the foreground.

The device is notified about a new update within 24 hours after it is published by the developer, after which the app is updated the next time the constraints above are met.

AUTO_UPDATE_POSTPONED

The app is not automatically updated for a maximum of 90 days after the app becomes out of date.

90 days after the app becomes out of date, the latest available version is installed automatically with low priority (seeAUTO_UPDATE_DEFAULT). After the app is updated it is not automatically updated again until 90 days after it becomes out of date again.

The user can still manually update the app from the Play Store at any time.

AUTO_UPDATE_HIGH_PRIORITY

The app is updated as soon as possible. No constraints are applied.

The device is notified as soon as possible about a new update after it becomes available.

NOTE: Updates to apps with larger deployments across Android's ecosystem can take up to 24h.

ExtensionConfig

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 therestricted App Standby Bucket. Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use theclear app data command on extension apps if needed for Android 11 and above.

JSON representation
{"signingKeyFingerprintsSha256":[string],"notificationReceiver":string}
Fields
signingKeyFingerprintsSha256[]
(deprecated)

string

signingKeyFingerprintsSha256 is deprecated - useApplicationPolicy.signingKeyCerts instead. IfApplicationPolicy.signingKeyCerts is set, this field must be empty or must contain the same signing key certificate fingerprints. Otherwise, the policy is rejected.

Hex-encoded SHA-256 hashes of the signing key certificates of the extension app. Only hexadecimal string representations of 64 characters are valid.

The signing key certificate fingerprints are always obtained from the Play Store and this field is used to provide additional signing key certificate fingerprints. However, if the application is not available on the Play Store, this field needs to be set. ANonComplianceDetail withINVALID_VALUE is reported if this field is not set when the application is not available on the Play Store.

The signing key certificate fingerprint of the extension app on the device must match one of the signing key certificate fingerprints obtained from the Play Store or the ones provided in this field for the app to be able to communicate with Android Device Policy.

In production use cases, it is recommended to leave this empty.

notificationReceiver
(deprecated)

string

notificationReceiver is deprecated - useCOMPANION_APP role instead.

Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. The service must be exported in the extension app'sAndroidManifest.xml and extendNotificationReceiverService (seeIntegrate with the AMAPI SDK guide for more details).

AlwaysOnVpnLockdownExemption

Controls whether an app is exempt from thealwaysOnVpnPackage.lockdownEnabled setting.

Enums
ALWAYS_ON_VPN_LOCKDOWN_EXEMPTION_UNSPECIFIEDUnspecified. Defaults toVPN_LOCKDOWN_ENFORCED.
VPN_LOCKDOWN_ENFORCEDThe app respects the always-on VPN lockdown setting.
VPN_LOCKDOWN_EXEMPTIONThe app is exempt from the always-on VPN lockdown setting.

WorkProfileWidgets

Controls if a work profile application is allowed to add widgets to the home screen.

Enums
WORK_PROFILE_WIDGETS_UNSPECIFIEDUnspecified. Defaults toworkProfileWidgetsDefault
WORK_PROFILE_WIDGETS_ALLOWEDWork profile widgets are allowed. This means the application will be able to add widgets to the home screen.
WORK_PROFILE_WIDGETS_DISALLOWEDWork profile widgets are disallowed. This means the application will not be able to add widgets to the home screen.

CredentialProviderPolicy

Whether the app is allowed to act as a credential provider on Android 14 and above.

Enums
CREDENTIAL_PROVIDER_POLICY_UNSPECIFIEDUnspecified. The behaviour is governed bycredentialProviderPolicyDefault.
CREDENTIAL_PROVIDER_ALLOWEDApp is allowed to act as a credential provider.

CustomAppConfig

Configuration for a custom app.

JSON representation
{"userUninstallSettings":enum (UserUninstallSettings)}
Fields
userUninstallSettings

enum (UserUninstallSettings)

Optional. User uninstall settings of the custom app.

UserUninstallSettings

Specifies if a user is allowed to uninstall the custom app.

Enums
USER_UNINSTALL_SETTINGS_UNSPECIFIEDUnspecified. Defaults toDISALLOW_UNINSTALL_BY_USER.
DISALLOW_UNINSTALL_BY_USERUser is not allowed to uninstall the custom app.
ALLOW_UNINSTALL_BY_USERUser is allowed to uninstall the custom app.

InstallConstraint

Amongst apps withInstallType set to:

this 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.

JSON representation
{"networkTypeConstraint":enum (NetworkTypeConstraint),"chargingConstraint":enum (ChargingConstraint),"deviceIdleConstraint":enum (DeviceIdleConstraint)}
Fields
networkTypeConstraint

enum (NetworkTypeConstraint)

Optional. Network type constraint.

chargingConstraint

enum (ChargingConstraint)

Optional. Charging constraint.

deviceIdleConstraint

enum (DeviceIdleConstraint)

Optional. Device idle constraint.

NetworkTypeConstraint

Network type constraint.

Enums
NETWORK_TYPE_CONSTRAINT_UNSPECIFIEDUnspecified. Default toINSTALL_ON_ANY_NETWORK.
INSTALL_ON_ANY_NETWORKAny active networks (Wi-Fi, cellular, etc.).
INSTALL_ONLY_ON_UNMETERED_NETWORKAny unmetered network (e.g. Wi-FI).

ChargingConstraint

Charging constraint.

Enums
CHARGING_CONSTRAINT_UNSPECIFIEDUnspecified. Default toCHARGING_NOT_REQUIRED.
CHARGING_NOT_REQUIREDDevice doesn't have to be charging.
INSTALL_ONLY_WHEN_CHARGINGDevice has to be charging.

DeviceIdleConstraint

Device idle state constraint.

Enums
DEVICE_IDLE_CONSTRAINT_UNSPECIFIEDUnspecified. Default toDEVICE_IDLE_NOT_REQUIRED.
DEVICE_IDLE_NOT_REQUIREDDevice doesn't have to be idle, app can be installed while the user is interacting with the device.
INSTALL_ONLY_WHEN_DEVICE_IDLEDevice has to be idle.

UserControlSettings

Specifies whether user control is permitted for a given app. User control includes user actions like force-stopping and clearing app data.

Enums
USER_CONTROL_SETTINGS_UNSPECIFIED

Uses the default behaviour of the app to determine if user control is allowed or disallowed. User control is allowed by default for most apps but disallowed for following types of apps:

  • extension apps (seeextensionConfig for more details)
  • kiosk apps (seeKIOSK install type for more details)
  • apps withroles set to a nonempty list
  • other critical system apps
USER_CONTROL_ALLOWED

User control is allowed for the app. Kiosk apps can use this to allow user control. For extension apps (seeextensionConfig for more details), user control is disallowed even if this value is set.

For apps withroles set to a nonempty list (exceptroles containing onlyKIOSK role), this value cannot be set.

For kiosk apps (seeKIOSK install type andKIOSK role type for more details), this value can be used to allow user control.

USER_CONTROL_DISALLOWEDUser control is disallowed for the app. This is supported on Android 11 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 11.

PreferentialNetworkId

Preferential network identifier.

Enums
PREFERENTIAL_NETWORK_ID_UNSPECIFIEDWhether this value is valid and what it means depends on where it is used, and this is documented on the relevant fields.
NO_PREFERENTIAL_NETWORKApplication does not use any preferential network.
PREFERENTIAL_NETWORK_ID_ONEPreferential network identifier 1.
PREFERENTIAL_NETWORK_ID_TWOPreferential network identifier 2.
PREFERENTIAL_NETWORK_ID_THREEPreferential network identifier 3.
PREFERENTIAL_NETWORK_ID_FOURPreferential network identifier 4.
PREFERENTIAL_NETWORK_ID_FIVEPreferential network identifier 5.

ApplicationSigningKeyCert

The application signing key certificate.

JSON representation
{"signingKeyCertFingerprintSha256":string}
Fields
signingKeyCertFingerprintSha256

string (bytes format)

Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. Otherwise, the policy is rejected.

A base64-encoded string.

Role

Role an app can have.

JSON representation
{"roleType":enum (RoleType)}
Fields
roleType

enum (RoleType)

Required. The type of the role an app can have.

RoleType

The type of the role an app can hold.

Enums
ROLE_TYPE_UNSPECIFIEDThe role type is unspecified. This value must not be used.
COMPANION_APP

The role type for companion apps. This role enables the app as a companion app with the capability of interacting with Android Device Policy offline. This is the recommended way to configure an app as a companion app. For legacy way, seeextensionConfig.

On Android 14 and above, the app with this role is exempted from power and background execution restrictions, suspension and hibernation. On Android 11 and above, the user control is disallowed for the app with this role.userControlSettings cannot be set toUSER_CONTROL_ALLOWED for the app with this role.

Android Device Policy notifies the companion app of any local command status updates if the app has a service with<meta-dataandroid:name="com.google.android.managementapi.notification.NotificationReceiverService.SERVICE_COMMAND_STATUS"android:value="" />. SeeIntegrate with the AMAPI SDK guide for more details on the requirements for the service.

KIOSK

The role type for kiosk apps. An app can have this role only if it hasinstallType set toREQUIRED_FOR_SETUP orCUSTOM. Before adding this role to an app withCUSTOM install type, the app must already be installed on the device.

The app having this role type is set as the preferred home intent and allowlisted for lock task mode. When there is an app with this role type, status bar will be automatically disabled.

This is preferable to settinginstallType toKIOSK.

On Android 11 and above, the user control is disallowed butuserControlSettings can be set toUSER_CONTROL_ALLOWED to allow user control for the app with this role.

MOBILE_THREAT_DEFENSE_ENDPOINT_DETECTION_RESPONSE

The role type for Mobile Threat Defense (MTD) / Endpoint Detection & Response (EDR) apps.

On Android 14 and above, the app with this role is exempted from power and background execution restrictions, suspension and hibernation. On Android 11 and above, the user control is disallowed anduserControlSettings cannot be set toUSER_CONTROL_ALLOWED for the app with this role.

SYSTEM_HEALTH_MONITORING

The role type for system health monitoring apps.

On Android 14 and above, the app with this role is exempted from power and background execution restrictions, suspension and hibernation. On Android 11 and above, the user control is disallowed anduserControlSettings cannot be set toUSER_CONTROL_ALLOWED for the app with this role.

KeyguardDisabledFeature

Keyguard (lock screen) features that can be disabled..

Enums
KEYGUARD_DISABLED_FEATURE_UNSPECIFIEDThis value is ignored.
CAMERADisable the camera on secure keyguard screens (e.g. PIN).
NOTIFICATIONSDisable showing all notifications on secure keyguard screens.
UNREDACTED_NOTIFICATIONSDisable unredacted notifications on secure keyguard screens.
TRUST_AGENTSIgnore trust agent state on secure keyguard screens.
DISABLE_FINGERPRINTDisable fingerprint sensor on secure keyguard screens.
DISABLE_REMOTE_INPUTOn devices running Android 6 and below, disables text entry into notifications on secure keyguard screens. Has no effect on Android 7 and above.
FACEDisable face authentication on secure keyguard screens.
IRISDisable iris authentication on secure keyguard screens.
BIOMETRICSDisable all biometric authentication on secure keyguard screens.
SHORTCUTSDisable all shortcuts on secure keyguard screen on Android 14 and above.
ALL_FEATURESDisable all current and future keyguard customizations.

PersistentPreferredActivity

A default activity for handling intents that match a particular intent filter.Note: To set up a kiosk, useInstallType toKIOSK rather than use persistent preferred activities.

JSON representation
{"receiverActivity":string,"actions":[string],"categories":[string]}
Fields
receiverActivity

string

The activity that should be the default intent handler. This should be an Android component name, e.g.com.android.enterprise.app/.MainActivity. Alternatively, the value may be the package name of an app, which causes Android Device Policy to choose an appropriate activity from the app to handle the intent.

actions[]

string

The intent actions to match in the filter. If any actions are included in the filter, then an intent's action must be one of those values for it to match. If no actions are included, the intent action is ignored.

categories[]

string

The intent categories to match in the filter. An intent includes the categories that it requires, all of which must be included in the filter in order to match. In other words, adding a category to the filter has no impact on matching unless that category is specified in the intent.

SystemUpdate

Configuration for managing system updates

Note:Google Play system updates (also called Mainline updates) are automatically downloaded but require a device reboot to be installed. Refer to the mainline section inManage system updates for further details.

JSON representation
{"type":enum (SystemUpdateType),"startMinutes":integer,"endMinutes":integer,"freezePeriods":[{object (FreezePeriod)}]}
Fields
type

enum (SystemUpdateType)

The type of system update to configure.

startMinutes

integer

If the type isWINDOWED, the start of the maintenance window, measured as the number of minutes after midnight in the device's local time. This value must be between 0 and 1439, inclusive.

endMinutes

integer

If the type isWINDOWED, the end of the maintenance window, measured as the number of minutes after midnight in device's local time. This value must be between 0 and 1439, inclusive. If this value is less thanstartMinutes, then the maintenance window spans midnight. If the maintenance window specified is smaller than 30 minutes, the actual window is extended to 30 minutes beyond the start time.

freezePeriods[]

object (FreezePeriod)

An annually repeating time period in which over-the-air (OTA) system updates are postponed to freeze the OS version running on a device. To prevent freezing the device indefinitely, each freeze period must be separated by at least 60 days.

SystemUpdateType

The type of system update configuration.

Enums
SYSTEM_UPDATE_TYPE_UNSPECIFIEDFollow the default update behavior for the device, which typically requires the user to accept system updates.
AUTOMATICInstall automatically as soon as an update is available.
WINDOWED

Install automatically within a daily maintenance window. This also configures Play apps to be updated within the window. This is strongly recommended for kiosk devices because this is the only way apps persistently pinned to the foreground can be updated by Play.

IfautoUpdateMode is set toAUTO_UPDATE_HIGH_PRIORITY for an app, then the maintenance window is ignored for that app and it is updated as soon as possible even outside of the maintenance window.

POSTPONEPostpone automatic install up to a maximum of 30 days. This policy does not affect security updates (e.g. monthly security patches).

FreezePeriod

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 asSYSTEM_UPDATE_TYPE_UNSPECIFIED, because freeze periods require a defined policy to be specified.

JSON representation
{"startDate":{object (Date)},"endDate":{object (Date)}}
Fields
startDate

object (Date)

The start date (inclusive) of the freeze period. Note:day andmonth must be set.year should not be set as it is not used. For example,{"month": 1,"date": 30}.

endDate

object (Date)

The end date (inclusive) of the freeze period. Must be no later than 90 days from the start date. If the end date is earlier than the start date, the freeze period is considered wrapping year-end. Note:day andmonth must be set.year should not be set as it is not used. For example,{"month": 1,"date": 30}.

Date

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:

JSON representation
{"year":integer,"month":integer,"day":integer}
Fields
year

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

month

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

day

integer

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

StatusReportingSettings

Settings controlling the behavior of status reports.

JSON representation
{"applicationReportsEnabled":boolean,"deviceSettingsEnabled":boolean,"softwareInfoEnabled":boolean,"memoryInfoEnabled":boolean,"networkInfoEnabled":boolean,"displayInfoEnabled":boolean,"powerManagementEventsEnabled":boolean,"hardwareStatusEnabled":boolean,"systemPropertiesEnabled":boolean,"applicationReportingSettings":{object (ApplicationReportingSettings)},"commonCriteriaModeEnabled":boolean,"defaultApplicationInfoReportingEnabled":boolean}
Fields
applicationReportsEnabled

boolean

Whetherapp reports are enabled.

deviceSettingsEnabled

boolean

Whetherdevice settings reporting is enabled.

softwareInfoEnabled

boolean

Whethersoftware info reporting is enabled.

memoryInfoEnabled

boolean

Whethermemory event reporting is enabled.

networkInfoEnabled

boolean

Whethernetwork info reporting is enabled.

displayInfoEnabled

boolean

Whetherdisplays reporting is enabled. Report data is not available for personally owned devices with work profiles.

powerManagementEventsEnabled

boolean

Whetherpower management event reporting is enabled. Report data is not available for personally owned devices with work profiles.

hardwareStatusEnabled

boolean

Whetherhardware status reporting is enabled. Report data is not available for personally owned devices with work profiles.

systemPropertiesEnabled

boolean

Whether system properties reporting is enabled.

applicationReportingSettings

object (ApplicationReportingSettings)

Application reporting settings. Only applicable if applicationReportsEnabled is true.

commonCriteriaModeEnabled

boolean

WhetherCommon Criteria Mode reporting is enabled. This is supported only on company-owned devices.

defaultApplicationInfoReportingEnabled

boolean

Optional. WhetherdefaultApplicationInfo reporting is enabled.

ApplicationReportingSettings

Settings controlling the behavior of application reports.

JSON representation
{"includeRemovedApps":boolean}
Fields
includeRemovedApps

boolean

Whether removed apps are included in application reports.

PackageNameList

A list of package names.

JSON representation
{"packageNames":[string]}
Fields
packageNames[]

string

A list of package names.

BatteryPluggedMode

Modes for plugging in the battery.

Enums
BATTERY_PLUGGED_MODE_UNSPECIFIEDThis value is ignored.
ACPower source is an AC charger.
USBPower source is a USB port.
WIRELESSPower source is wireless.

ProxyInfo

Configuration info for an HTTP proxy. For a direct proxy, set thehost,port, andexcludedHosts fields. For a PAC script proxy, set thepacUri field.

JSON representation
{"host":string,"port":integer,"excludedHosts":[string],"pacUri":string}
Fields
host

string

The host of the direct proxy.

port

integer

The port of the direct proxy.

excludedHosts[]

string

For a direct proxy, the hosts for which the proxy is bypassed. The host names may contain wildcards such as *.example.com.

pacUri

string

The URI of the PAC script used to configure the proxy.

ChoosePrivateKeyRule

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 callsKeyChain.choosePrivateKeyAlias (or any overloads) to request a private key alias for a given URL, or for rules that are not URL-specific (that is, ifurlPattern is not set, or set to the empty string or.*) on Android 11 and above, directly so that the app can callKeyChain.getPrivateKey, without first having to callKeyChain.choosePrivateKeyAlias.

When an app callsKeyChain.choosePrivateKeyAlias if more than onechoosePrivateKeyRules matches, the last matching rule defines which key alias to return.

JSON representation
{"urlPattern":string,"packageNames":[string],"privateKeyAlias":string}
Fields
urlPattern

string

The URL pattern to match against the URL of the request. If not set or empty, it matches all URLs. This uses the regular expression syntax ofjava.util.regex.Pattern.

packageNames[]

string

The package names to which this rule applies. The signing key certificate fingerprint of the app is verified against the signing key certificate fingerprints provided by Play Store andApplicationPolicy.signingKeyCerts . If no package names are specified, then the alias is provided to all apps that callKeyChain.choosePrivateKeyAlias or any overloads (but not without callingKeyChain.choosePrivateKeyAlias, even on Android 11 and above). Any app with the same Android UID as a package specified here will have access when they callKeyChain.choosePrivateKeyAlias.

privateKeyAlias

string

The alias of the private key to be used.

AlwaysOnVpnPackage

Configuration for an always-on VPN connection.

JSON representation
{"packageName":string,"lockdownEnabled":boolean}
Fields
packageName

string

The package name of the VPN app.

lockdownEnabled

boolean

Disallows networking when the VPN is not connected.

LocationMode

The degree of location detection enabled on work profile and fully managed devices.

Enums
LOCATION_MODE_UNSPECIFIEDDefaults toLOCATION_USER_CHOICE.
HIGH_ACCURACY

On Android 8 and below, all location detection methods are enabled, including GPS, networks, and other sensors. On Android 9 and above, this is equivalent toLOCATION_ENFORCED.

UseLOCATION_ENFORCED instead.

SENSORS_ONLY

On Android 8 and below, only GPS and other sensors are enabled. On Android 9 and above, this is equivalent toLOCATION_ENFORCED.

UseLOCATION_ENFORCED instead.

BATTERY_SAVING

On Android 8 and below, only the network location provider is enabled. On Android 9 and above, this is equivalent toLOCATION_ENFORCED.

UseLOCATION_ENFORCED instead.

OFF

On Android 8 and below, location setting and accuracy are disabled. On Android 9 and above, this is equivalent toLOCATION_DISABLED.

UseLOCATION_DISABLED instead.

LOCATION_USER_CHOICELocation setting is not restricted on the device. No specific behavior is set or enforced.
LOCATION_ENFORCEDEnable location setting on the device.Important: On Android 11 and above, work profiles on company-owned devices cannot directly enforce enabling of location services. WhenLOCATION_ENFORCED is set, then aNonComplianceDetail withUSER_ACTION is reported. Compliance can only be restored once the user manually turns on location services through the device's Settings application.
LOCATION_DISABLEDDisable location setting on the device.Important: On Android 11 and above, work profiles on company-owned devices cannot directly enforce disabling of location services. WhenLOCATION_DISABLED is set, then anonComplianceDetail withUSER_ACTION is reported. Compliance can only be restored once the user manually turns off location services through the device's Settings application.

ComplianceRule

This item is deprecated!

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 setpolicyCompliant to false for theDevice 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.

JSON representation
{"disableApps":boolean,"packageNamesToDisable":[string],// Union fieldcondition can be only one of the following:"nonComplianceDetailCondition":{object (NonComplianceDetailCondition)},"apiLevelCondition":{object (ApiLevelCondition)}// End of list of possible types for union fieldcondition.}
Fields
disableApps

boolean

If set to true, the rule includes a mitigating action to disable apps so that the device is effectively disabled, but app data is preserved. If the device is running an app in locked task mode, the app will be closed and a UI showing the reason for non-compliance will be displayed.

packageNamesToDisable[]

string

If set, the rule includes a mitigating action to disable apps specified in the list, but app data is preserved.

Union fieldcondition. The condition, which when satisfied, triggers the mitigating actions defined in the rule. Exactly one of the conditions must be set.condition can be only one of the following:
nonComplianceDetailCondition

object (NonComplianceDetailCondition)

A condition which is satisfied if there existsany matchingNonComplianceDetail for the device.

apiLevelCondition

object (ApiLevelCondition)

A condition which is satisfied if the Android Framework API level on the device doesn't meet a minimum requirement.

NonComplianceDetailCondition

This item is deprecated!

A compliance rule condition which is satisfied if there existsany matchingNonComplianceDetail for the device. ANonComplianceDetail matches aNonComplianceDetailCondition ifall the fields which are set within theNonComplianceDetailCondition match the correspondingNonComplianceDetail fields.

JSON representation
{"settingName":string,"nonComplianceReason":enum (NonComplianceReason),"packageName":string}
Fields
settingName

string

The name of the policy setting. This is the JSON field name of a top-levelPolicy field. If not set, then this condition matches any setting name.

nonComplianceReason

enum (NonComplianceReason)

The reason the device is not in compliance with the setting. If not set, then this condition matches any reason.

packageName

string

The package name of the app that's out of compliance. If not set, then this condition matches any package name.

ApiLevelCondition

This item is deprecated!

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.

JSON representation
{"minApiLevel":integer}
Fields
minApiLevel

integer

The minimum desired Android Framework API level. If the device doesn't meet the minimum requirement, this condition is satisfied. Must be greater than zero.

AppAutoUpdatePolicy

Recommended alternative:autoUpdateMode which is set per app, provides greater flexibility around update frequency.

WhenautoUpdateMode is set toAUTO_UPDATE_POSTPONED orAUTO_UPDATE_HIGH_PRIORITY, this field has no effect.

The app auto-update policy, which controls when automatic app updates can be applied.Important: Changes to app update policies don't affect updates that are in progress. Any policy changes will apply to subsequent app updates.

Enums
APP_AUTO_UPDATE_POLICY_UNSPECIFIEDThe auto-update policy is not set. Equivalent toCHOICE_TO_THE_USER.
CHOICE_TO_THE_USERThe user can control auto-updates.
NEVERApps are never auto-updated.
WIFI_ONLYApps are auto-updated over Wi-Fi only.
ALWAYSApps are auto-updated at any time. Data charges may apply.

AppTrack

A Google Play app release track.

Enums
APP_TRACK_UNSPECIFIEDThis value is ignored.
PRODUCTIONThe production track, which provides the latest stable release.
BETAThe beta track, which provides the latest beta release.

EncryptionPolicy

Type of encryption

Enums
ENCRYPTION_POLICY_UNSPECIFIEDThis value is ignored, i.e. no encryption required
ENABLED_WITHOUT_PASSWORDEncryption required but no password required to boot
ENABLED_WITH_PASSWORDEncryption required with password required to boot

PlayStoreMode

Possible values for Play Store mode policy.

Enums
PLAY_STORE_MODE_UNSPECIFIEDUnspecified. Defaults to WHITELIST.
WHITELISTOnly apps that are in the policy are available and any app not in the policy will be automatically uninstalled from the device.
BLACKLISTAll apps are available and any app that should not be on the device should be explicitly marked as 'BLOCKED' in theapplications policy.

SetupAction

An action executed during setup.

JSON representation
{"title":{object (UserFacingMessage)},"description":{object (UserFacingMessage)},// Union fieldaction can be only one of the following:"launchApp":{object (LaunchAppAction)}// End of list of possible types for union fieldaction.}
Fields
title

object (UserFacingMessage)

Title of this action.

description

object (UserFacingMessage)

Description of this action.

Union fieldaction. The action to execute during setup.action can be only one of the following:
launchApp

object (LaunchAppAction)

An action to launch an app. The app will be launched with an intent containing an extra with keycom.google.android.apps.work.clouddpc.EXTRA_LAUNCHED_AS_SETUP_ACTION set to the boolean valuetrue to indicate that this is a setup action flow. IfSetupAction references an app, the correspondinginstallType in the application policy must be set asREQUIRED_FOR_SETUP or said setup will fail.

LaunchAppAction

An action to launch an app.

JSON representation
{// Union fieldlaunch can be only one of the following:"packageName":string// End of list of possible types for union fieldlaunch.}
Fields
Union fieldlaunch. Description of launch action to be executedlaunch can be only one of the following:
packageName

string

Package name of app to be launched

PolicyEnforcementRule

A rule that defines the actions to take if a device or work profile is not compliant with the policy specified insettingName. 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.

JSON representation
{"blockAction":{object (BlockAction)},"wipeAction":{object (WipeAction)},// Union fieldtrigger can be only one of the following:"settingName":string// End of list of possible types for union fieldtrigger.}
Fields
blockAction

object (BlockAction)

An action to block access to apps and data on a company owned device or in a work profile. This action also triggers a user-facing notification with information (where possible) on how to correct the compliance issue. Note:wipeAction must also be specified.

wipeAction

object (WipeAction)

An action to reset a company owned device or delete a work profile. Note:blockAction must also be specified.

Union fieldtrigger. Condition which will trigger this rule.trigger can be only one of the following:
settingName

string

The top-level policy to enforce. For example,applications orpasswordPolicies.

BlockAction

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.

JSON representation
{"blockAfterDays":integer,"blockScope":enum (BlockScope)}
Fields
blockAfterDays

integer

Number of days the policy is non-compliant before the device or work profile is blocked. To block access immediately, set to 0.blockAfterDays must be less thanwipeAfterDays.

blockScope

enum (BlockScope)

Specifies the scope of thisBlockAction. Only applicable to devices that are company-owned.

BlockScope

Specifies the scope ofBlockAction. Only applicable to devices that are company-owned.

Enums
BLOCK_SCOPE_UNSPECIFIEDUnspecified. Defaults toBLOCK_SCOPE_WORK_PROFILE.
BLOCK_SCOPE_WORK_PROFILEBlock action is only applied to apps in the work profile. Apps in the personal profile are unaffected.
BLOCK_SCOPE_DEVICEBlock action is applied to the entire device, including apps in the personal profile.

WipeAction

An action to reset a company owned device or delete a work profile. Note:blockAction must also be specified.

JSON representation
{"wipeAfterDays":integer,"preserveFrp":boolean}
Fields
wipeAfterDays

integer

Number of days the policy is non-compliant before the device or work profile is wiped.wipeAfterDays must be greater thanblockAfterDays.

preserveFrp

boolean

Whether the factory-reset protection data is preserved on the device. This setting doesn’t apply to work profiles.

KioskCustomization

Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, setkioskCustomLauncherEnabled totrue or specify an app in the policy withinstallTypeKIOSK.

JSON representation
{"powerButtonActions":enum (PowerButtonActions),"systemErrorWarnings":enum (SystemErrorWarnings),"systemNavigation":enum (SystemNavigation),"statusBar":enum (StatusBar),"deviceSettings":enum (DeviceSettings)}
Fields
powerButtonActions

enum (PowerButtonActions)

Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button.

systemErrorWarnings

enum (SystemErrorWarnings)

Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI.

systemNavigation

enum (SystemNavigation)

Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode.

statusBar

enum (StatusBar)

Specifies whether system info and notifications are disabled in kiosk mode.

deviceSettings

enum (DeviceSettings)

Specifies whether the Settings app is allowed in kiosk mode.

PowerButtonActions

Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button.

Enums
POWER_BUTTON_ACTIONS_UNSPECIFIEDUnspecified, defaults toPOWER_BUTTON_AVAILABLE.
POWER_BUTTON_AVAILABLEThe power menu (e.g. Power off, Restart) is shown when a user long-presses the Power button of a device in kiosk mode.
POWER_BUTTON_BLOCKEDThe power menu (e.g. Power off, Restart) is not shown when a user long-presses the Power button of a device in kiosk mode. Note: this may prevent users from turning off the device.

SystemErrorWarnings

Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode.

Enums
SYSTEM_ERROR_WARNINGS_UNSPECIFIEDUnspecified, defaults toERROR_AND_WARNINGS_MUTED.
ERROR_AND_WARNINGS_ENABLEDAll system error dialogs such as crash and app not responding (ANR) are displayed.
ERROR_AND_WARNINGS_MUTEDAll system error dialogs, such as crash and app not responding (ANR) are blocked. When blocked, the system force-stops the app as if the user closes the app from the UI.

SystemNavigation

Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode.

Enums
SYSTEM_NAVIGATION_UNSPECIFIEDUnspecified, defaults toNAVIGATION_DISABLED.
NAVIGATION_ENABLEDHome and overview buttons are enabled.
NAVIGATION_DISABLEDThe home and Overview buttons are not accessible.
HOME_BUTTON_ONLYOnly the home button is enabled.

StatusBar

Specifies whether system info and notifications are disabled in kiosk mode.

Enums
STATUS_BAR_UNSPECIFIEDUnspecified, defaults toINFO_AND_NOTIFICATIONS_DISABLED.
NOTIFICATIONS_AND_SYSTEM_INFO_ENABLED

System info and notifications are shown on the status bar in kiosk mode.

Note: For this policy to take effect, the device's home button must be enabled usingkioskCustomization.systemNavigation.

NOTIFICATIONS_AND_SYSTEM_INFO_DISABLEDSystem info and notifications are disabled in kiosk mode.
SYSTEM_INFO_ONLYOnly system info is shown on the status bar.

DeviceSettings

Specifies whether a user can access the device's Settings app while in kiosk mode.

Enums
DEVICE_SETTINGS_UNSPECIFIEDUnspecified, defaults toSETTINGS_ACCESS_ALLOWED.
SETTINGS_ACCESS_ALLOWEDAccess to the Settings app is allowed in kiosk mode.
SETTINGS_ACCESS_BLOCKEDAccess to the Settings app is not allowed in kiosk mode.

AdvancedSecurityOverrides

Advanced security settings. In most cases, setting these is not needed.

JSON representation
{"untrustedAppsPolicy":enum (UntrustedAppsPolicy),"googlePlayProtectVerifyApps":enum (GooglePlayProtectVerifyApps),"developerSettings":enum (DeveloperSettings),"commonCriteriaMode":enum (CommonCriteriaMode),"personalAppsThatCanReadWorkNotifications":[string],"mtePolicy":enum (MtePolicy),"contentProtectionPolicy":enum (ContentProtectionPolicy)}
Fields
untrustedAppsPolicy

enum (UntrustedAppsPolicy)

The policy for untrusted apps (apps from unknown sources) enforced on the device. ReplacesinstallUnknownSourcesAllowed (deprecated).

googlePlayProtectVerifyApps

enum (GooglePlayProtectVerifyApps)

WhetherGoogle Play Protect verification is enforced. ReplacesensureVerifyAppsEnabled (deprecated).

developerSettings

enum (DeveloperSettings)

Controls access to developer settings: developer options and safe boot. ReplacessafeBootDisabled (deprecated) anddebuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, aNonComplianceDetail withMANAGEMENT_MODE is reported.

commonCriteriaMode

enum (CommonCriteriaMode)

Controls Common Criteria Mode—security standards defined in theCommon Criteria for Information Technology Security Evaluation (CC). Enabling Common Criteria Mode increases certain security components on a device, seeCommonCriteriaMode for details.

Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured.

personalAppsThatCanReadWorkNotifications[]

string

Personal apps that can read work profile notifications using aNotificationListenerService. By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name.

mtePolicy

enum (MtePolicy)

Optional. ControlsMemory Tagging Extension (MTE) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, aNonComplianceDetail withPENDING is reported if the policy change is pending a device reboot.

contentProtectionPolicy

enum (ContentProtectionPolicy)

Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above.

UntrustedAppsPolicy

The policy for untrusted apps (apps from unknown sources) enforced on the device. ReplacesinstallUnknownSourcesAllowed (deprecated).

Enums
UNTRUSTED_APPS_POLICY_UNSPECIFIEDUnspecified. Defaults to DISALLOW_INSTALL.
DISALLOW_INSTALLDefault. Disallow untrusted app installs on entire device.
ALLOW_INSTALL_IN_PERSONAL_PROFILE_ONLYFor devices with work profiles, allow untrusted app installs in the device's personal profile only.
ALLOW_INSTALL_DEVICE_WIDEAllow untrusted app installs on entire device.

GooglePlayProtectVerifyApps

WhetherGoogle Play Protect verification is enforced. ReplacesensureVerifyAppsEnabled (deprecated).

Enums
GOOGLE_PLAY_PROTECT_VERIFY_APPS_UNSPECIFIEDUnspecified. Defaults to VERIFY_APPS_ENFORCED.
VERIFY_APPS_ENFORCEDDefault. Force-enables app verification.
VERIFY_APPS_USER_CHOICEAllows the user to choose whether to enable app verification.

DeveloperSettings

Controls access to developer settings: developer options and safe boot. ReplacessafeBootDisabled (deprecated) anddebuggingFeaturesAllowed (deprecated).

Enums
DEVELOPER_SETTINGS_UNSPECIFIEDUnspecified. Defaults to DEVELOPER_SETTINGS_DISABLED.
DEVELOPER_SETTINGS_DISABLEDDefault. Disables all developer settings and prevents the user from accessing them.
DEVELOPER_SETTINGS_ALLOWEDAllows all developer settings. The user can access and optionally configure the settings.

CommonCriteriaMode

Controls Common Criteria Mode—security standards defined in theCommon Criteria for Information Technology Security Evaluation (CC). Enabling Common Criteria Mode increases certain security components on a device, including:

  1. AES-GCM encryption of Bluetooth Long Term Keys
  2. Wi-Fi configuration stores
  3. Additional network certificates validation requiring the use of TLSv1.2 to connect toAM API destination hosts
  4. Cryptographic policy integrity check. It is recommended to setstatusReportingSettings.commonCriteriaModeEnabled to true to obtain the status of policy integrity check. If the policy signature verification fails, then the policy is not applied on the device andcommonCriteriaModeInfo.policy_signature_verification_status is set toPOLICY_SIGNATURE_VERIFICATION_FAILED.

Common Criteria Mode is only supported on company-owned devices running Android 11 or above.

Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured.

Enums
COMMON_CRITERIA_MODE_UNSPECIFIEDUnspecified. Defaults to COMMON_CRITERIA_MODE_DISABLED.
COMMON_CRITERIA_MODE_DISABLEDDefault. Disables Common Criteria Mode.
COMMON_CRITERIA_MODE_ENABLEDEnables Common Criteria Mode.

MtePolicy

ControlsMemory Tagging Extension (MTE) on the device.

Enums
MTE_POLICY_UNSPECIFIEDUnspecified. Defaults toMTE_USER_CHOICE.
MTE_USER_CHOICEThe user can choose to enable or disable MTE on the device if the device supports this.
MTE_ENFORCED

MTE is enabled on the device and the user is not allowed to change this setting. This can be set on fully managed devices and work profiles on company-owned devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for other management modes. ANonComplianceDetail withDEVICE_INCOMPATIBLE is reported if the device does not support MTE.

Supported on Android 14 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 14.

MTE_DISABLED

MTE is disabled on the device and the user is not allowed to change this setting. This applies only on fully managed devices. In other cases, aNonComplianceDetail withMANAGEMENT_MODE is reported. ANonComplianceDetail withDEVICE_INCOMPATIBLE is reported if the device does not support MTE.

Supported on Android 14 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 14.

ContentProtectionPolicy

Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above.

Enums
CONTENT_PROTECTION_POLICY_UNSPECIFIEDUnspecified. Defaults toCONTENT_PROTECTION_DISABLED.
CONTENT_PROTECTION_DISABLEDContent protection is disabled and the user cannot change this.
CONTENT_PROTECTION_ENFORCED

Content protection is enabled and the user cannot change this.

Supported on Android 15 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 15.

CONTENT_PROTECTION_USER_CHOICE

Content protection is not controlled by the policy. The user is allowed to choose the behavior of content protection.

Supported on Android 15 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 15.

PersonalUsagePolicies

Policies controlling personal usage on a company-owned device with a work profile.

JSON representation
{"cameraDisabled":boolean,"screenCaptureDisabled":boolean,"accountTypesWithManagementDisabled":[string],"maxDaysWithWorkOff":integer,"personalPlayStoreMode":enum (PlayStoreMode),"personalApplications":[{object (PersonalApplicationPolicy)}],"privateSpacePolicy":enum (PrivateSpacePolicy),"bluetoothSharing":enum (BluetoothSharing)}
Fields
cameraDisabled

boolean

If true, the camera is disabled on the personal profile.

screenCaptureDisabled

boolean

If true, screen capture is disabled for all users.

accountTypesWithManagementDisabled[]

string

Account types that can't be managed by the user.

maxDaysWithWorkOff

integer

Controls how long the work profile can stay off. The minimum duration must be at least 3 days. Other details are as follows:

  • If the duration is set to 0, the feature is turned off.
  • If the duration is set to a value smaller than the minimum duration, the feature returns an error.
Note: If you want to avoid personal profiles beingsuspended during long periods of off-time, you can temporarily set a large value for this parameter.

personalPlayStoreMode

enum (PlayStoreMode)

Used together withpersonalApplications to control how apps in the personal profile are allowed or blocked.

personalApplications[]

object (PersonalApplicationPolicy)

Policy applied to applications in the personal profile.

privateSpacePolicy

enum (PrivateSpacePolicy)

Optional. Controls whether a private space is allowed on the device.

bluetoothSharing

enum (BluetoothSharing)

Optional. Whether bluetooth sharing is allowed.

PlayStoreMode

Used together withpersonalApplications to control how apps in the personal profile are allowed or blocked.

Enums
PLAY_STORE_MODE_UNSPECIFIEDUnspecified. Defaults toBLOCKLIST.
BLACKLIST

All Play Store apps are available for installation in the personal profile, except those whoseinstallType isBLOCKED inpersonalApplications.

BLACKLIST is deprecated - useBLOCKLIST instead.

BLOCKLISTAll Play Store apps are available for installation in the personal profile, except those whoseinstallType isBLOCKED inpersonalApplications.
ALLOWLISTOnly apps explicitly specified inpersonalApplications withinstallType set toAVAILABLE are allowed to be installed in the personal profile.

PersonalApplicationPolicy

Policies for apps in the personal profile of a company-owned device with a work profile.

JSON representation
{"packageName":string,"installType":enum (InstallType)}
Fields
packageName

string

The package name of the application.

installType

enum (InstallType)

The type of installation to perform.

InstallType

Types of installation behaviors a personal profile application can have.

Enums
INSTALL_TYPE_UNSPECIFIEDUnspecified. Defaults toAVAILABLE.
BLOCKEDThe app is blocked and can't be installed in the personal profile. If the app was previously installed in the device, it will be uninstalled.
AVAILABLEThe app is available to install in the personal profile.

PrivateSpacePolicy

Controls whether aprivate space is allowed on the device.

Enums
PRIVATE_SPACE_POLICY_UNSPECIFIEDUnspecified. Defaults toPRIVATE_SPACE_ALLOWED.
PRIVATE_SPACE_ALLOWEDUsers can create a private space profile.
PRIVATE_SPACE_DISALLOWEDUsers cannot create a private space profile. Supported only for company-owned devices with a work profile. Caution: Any existing private space will be removed.

BluetoothSharing

Whether bluetooth sharing is allowed in the personal profile of a company-owned device with a work profile.

Enums
BLUETOOTH_SHARING_UNSPECIFIEDUnspecified. Defaults toBLUETOOTH_SHARING_ALLOWED.
BLUETOOTH_SHARING_ALLOWED

Bluetooth sharing is allowed on personal profile.

Supported on Android 8 and above. ANonComplianceDetail withMANAGEMENT_MODE is reported if this is set for a personal device.

BLUETOOTH_SHARING_DISALLOWED

Bluetooth sharing is disallowed on personal profile.

Supported on Android 8 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 8. ANonComplianceDetail withMANAGEMENT_MODE is reported if this is set for a personal device.

AutoDateAndTimeZone

Whether auto date, time, and time zone is enabled on a company-owned device.

Enums
AUTO_DATE_AND_TIME_ZONE_UNSPECIFIEDUnspecified. Defaults toAUTO_DATE_AND_TIME_ZONE_USER_CHOICE.
AUTO_DATE_AND_TIME_ZONE_USER_CHOICEAuto date, time, and time zone are left to user's choice.
AUTO_DATE_AND_TIME_ZONE_ENFORCEDEnforce auto date, time, and time zone on the device.

OncCertificateProvider

This feature is not generally available.

JSON representation
{"certificateReferences":[string],// Union fieldendpoint can be only one of the following:"contentProviderEndpoint":{object (ContentProviderEndpoint)}// End of list of possible types for union fieldendpoint.}
Fields
certificateReferences[]

string

This feature is not generally available.

Union fieldendpoint.

This feature is not generally available.endpoint can be only one of the following:

contentProviderEndpoint

object (ContentProviderEndpoint)

This feature is not generally available.

ContentProviderEndpoint

This feature is not generally available.

JSON representation
{"uri":string,"packageName":string,"signingCertsSha256":[string]}
Fields
uri

string

This feature is not generally available.

packageName

string

This feature is not generally available.

signingCertsSha256[]

string

Required. This feature is not generally available.

CrossProfilePolicies

Controls the data from the work profile that can be accessed from the personal profile and vice versa. ANonComplianceDetail withMANAGEMENT_MODE is reported if the device does not have a work profile.

JSON representation
{"showWorkContactsInPersonalProfile":enum (ShowWorkContactsInPersonalProfile),"crossProfileCopyPaste":enum (CrossProfileCopyPaste),"crossProfileDataSharing":enum (CrossProfileDataSharing),"workProfileWidgetsDefault":enum (WorkProfileWidgetsDefault),"crossProfileAppFunctions":enum (CrossProfileAppFunctions),"exemptionsToShowWorkContactsInPersonalProfile":{object (PackageNameList)}}
Fields
showWorkContactsInPersonalProfile

enum (ShowWorkContactsInPersonalProfile)

Whether personal apps can access contacts stored in the work profile.

See alsoexemptionsToShowWorkContactsInPersonalProfile.

crossProfileCopyPaste

enum (CrossProfileCopyPaste)

Whether text copied from one profile (personal or work) can be pasted in the other profile.

crossProfileDataSharing

enum (CrossProfileDataSharing)

Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately.

workProfileWidgetsDefault

enum (WorkProfileWidgetsDefault)

Specifies the default behaviour for work profile widgets. If the policy does not specifyworkProfileWidgets for a specific application, it will behave according to the value specified here.

crossProfileAppFunctions

enum (CrossProfileAppFunctions)

Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile.

exemptionsToShowWorkContactsInPersonalProfile

object (PackageNameList)

List of apps which are excluded from theShowWorkContactsInPersonalProfile setting. For this to be set,ShowWorkContactsInPersonalProfile must be set to one of the following values:

Supported on Android 14 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 14.

ShowWorkContactsInPersonalProfile

Whether personal apps can access work profile contacts including contact searches and incoming calls

Note: Once a work contact is accessed by any personal app, it cannot be guaranteed to stay with the same app, as the contact could be shared or transferred to any other app, depending on the allowed app’s behaviour.

Enums
SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_UNSPECIFIED

Unspecified. Defaults toSHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED.

When this is set,exemptionsToShowWorkContactsInPersonalProfile must not be set.

SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED

Prevents personal apps from accessing work profile contacts and looking up work contacts.

When this is set, personal apps specified inexemptionsToShowWorkContactsInPersonalProfile are allowlisted and can access work profile contacts directly.

Supported on Android 7.0 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 7.0.

SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED

Default. Allows apps in the personal profile to access work profile contacts including contact searches and incoming calls.

When this is set, personal apps specified inexemptionsToShowWorkContactsInPersonalProfile are blocklisted and can not access work profile contacts directly.

Supported on Android 7.0 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 7.0.

SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM

Prevents most personal apps from accessing work profile contacts including contact searches and incoming calls, except for the OEM default Dialer, Messages, and Contacts apps. Neither user-configured Dialer, Messages, and Contacts apps, nor any other system or play installed apps, will be able to query work contacts directly.

When this is set, personal apps specified inexemptionsToShowWorkContactsInPersonalProfile are allowlisted and can access work profile contacts.

Supported on Android 14 and above. If this is set on a device with Android version less than 14, the behaviour falls back toSHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED and aNonComplianceDetail withAPI_LEVEL is reported.

CrossProfileCopyPaste

Whether text copied from one profile (personal or work) can be pasted in the other profile.

Enums
CROSS_PROFILE_COPY_PASTE_UNSPECIFIEDUnspecified. Defaults to COPY_FROM_WORK_TO_PERSONAL_DISALLOWED
COPY_FROM_WORK_TO_PERSONAL_DISALLOWEDDefault. Prevents users from pasting into the personal profile text copied from the work profile. Text copied from the personal profile can be pasted into the work profile, and text copied from the work profile can be pasted into the work profile.
CROSS_PROFILE_COPY_PASTE_ALLOWEDText copied in either profile can be pasted in the other profile.

CrossProfileDataSharing

Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. This includes actions like opening a web browser, opening a map, sharing content, opening a document, etc. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately.

Enums
CROSS_PROFILE_DATA_SHARING_UNSPECIFIEDUnspecified. Defaults to DATA_SHARING_FROM_WORK_TO_PERSONAL_DISALLOWED.
CROSS_PROFILE_DATA_SHARING_DISALLOWEDPrevents data from being shared from both the personal profile to the work profile and the work profile to the personal profile.
DATA_SHARING_FROM_WORK_TO_PERSONAL_DISALLOWEDDefault. Prevents users from sharing data from the work profile to apps in the personal profile. Personal data can be shared with work apps.
CROSS_PROFILE_DATA_SHARING_ALLOWEDData from either profile can be shared with the other profile.

WorkProfileWidgetsDefault

Controls if work profile applications are allowed to add widgets to the home screen, where no app-specific policy is defined. Otherwise, the app-specific policy will have priority over this.

Enums
WORK_PROFILE_WIDGETS_DEFAULT_UNSPECIFIEDUnspecified. Defaults to WORK_PROFILE_WIDGETS_DEFAULT_DISALLOWED.
WORK_PROFILE_WIDGETS_DEFAULT_ALLOWEDWork profile widgets are allowed by default. This means that if the policy does not specifyworkProfileWidgets asWORK_PROFILE_WIDGETS_DISALLOWED for the application, it will be able to add widgets to the home screen.
WORK_PROFILE_WIDGETS_DEFAULT_DISALLOWEDWork profile widgets are disallowed by default. This means that if the policy does not specifyworkProfileWidgets asWORK_PROFILE_WIDGETS_ALLOWED for the application, it will be unable to add widgets to the home screen.

CrossProfileAppFunctions

Controls whether personal profile apps are allowed to invoke app functions exposed by apps in the work profile.

Enums
CROSS_PROFILE_APP_FUNCTIONS_UNSPECIFIEDUnspecified. IfappFunctions is set toAPP_FUNCTIONS_ALLOWED, defaults toCROSS_PROFILE_APP_FUNCTIONS_ALLOWED. IfappFunctions is set toAPP_FUNCTIONS_DISALLOWED, defaults toCROSS_PROFILE_APP_FUNCTIONS_DISALLOWED.
CROSS_PROFILE_APP_FUNCTIONS_DISALLOWEDPersonal profile apps are not allowed to invoke app functions exposed by apps in the work profile.
CROSS_PROFILE_APP_FUNCTIONS_ALLOWEDPersonal profile apps can invoke app functions exposed by apps in the work profile. If this is set,appFunctions must not be set toAPP_FUNCTIONS_DISALLOWED, otherwise the policy will be rejected.

PreferentialNetworkService

Controls whether preferential network service is enabled on the work profile or on fully managed devices. SeepreferentialNetworkService for details.

Enums
PREFERENTIAL_NETWORK_SERVICE_UNSPECIFIEDUnspecified. Defaults toPREFERENTIAL_NETWORK_SERVICES_DISABLED.
PREFERENTIAL_NETWORK_SERVICE_DISABLEDPreferential network service is disabled on the work profile.
PREFERENTIAL_NETWORK_SERVICE_ENABLEDPreferential network service is enabled on the work profile. This setting is only supported on work profiles on devices running Android 12 or above. Starting with Android 13, fully managed devices are also supported.

UsageLog

Controls types of device activity logs collected from the device and reported viaPub/Sub notification.

JSON representation
{"enabledLogTypes":[enum (LogType)],"uploadOnCellularAllowed":[enum (LogType)]}
Fields
enabledLogTypes[]

enum (LogType)

Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled.

uploadOnCellularAllowed[]

enum (LogType)

Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi.

LogType

The types of device activity logs that are reported from the device.

Enums
LOG_TYPE_UNSPECIFIEDThis value is not used.
SECURITY_LOGSEnable logging of on-device security events, like when the device password is incorrectly entered or removable storage is mounted. SeeUsageLogEvent for a complete description of the logged security events. Supported for fully managed devices on Android 7 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only security events from the work profile are logged. Can be overridden by the application delegated scopeSECURITY_LOGS
NETWORK_ACTIVITY_LOGSEnable logging of on-device network events, like DNS lookups and TCP connections. SeeUsageLogEvent for a complete description of the logged network events. Supported for fully managed devices on Android 8 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only network events from the work profile are logged. Can be overridden by the application delegated scopeNETWORK_ACTIVITY_LOGS

CameraAccess

Controls the use of the camera and whether the user has access to the camera access toggle. The camera access toggle exists on Android 12 and above. As a general principle, the possibility of disabling the camera applies device-wide on fully managed devices and only within the work profile on devices with a work profile. The possibility of disabling the camera access toggle applies only on fully managed devices, in which case it applies device-wide. For specifics, see the enum values.

Enums
CAMERA_ACCESS_UNSPECIFIEDIfcameraDisabled is true, this is equivalent toCAMERA_ACCESS_DISABLED. Otherwise, this is equivalent toCAMERA_ACCESS_USER_CHOICE.
CAMERA_ACCESS_USER_CHOICEThe fieldcameraDisabled is ignored. This is the default device behaviour: all cameras on the device are available. On Android 12 and above, the user can use the camera access toggle.
CAMERA_ACCESS_DISABLED

The fieldcameraDisabled is ignored. All cameras on the device are disabled (for fully managed devices, this applies device-wide and for work profiles this applies only to the work profile).

There are no explicit restrictions placed on the camera access toggle on Android 12 and above: on fully managed devices, the camera access toggle has no effect as all cameras are disabled. On devices with a work profile, this toggle has no effect on apps in the work profile, but it affects apps outside the work profile.

CAMERA_ACCESS_ENFORCEDThe fieldcameraDisabled is ignored. All cameras on the device are available. On fully managed devices running Android 12 and above, the user is unable to use the camera access toggle. On devices which are not fully managed or which run Android 11 or below, this is equivalent toCAMERA_ACCESS_USER_CHOICE.

MicrophoneAccess

On fully managed devices, controls the use of the microphone and whether the user has access to the microphone access toggle. This setting has no effect on devices which are not fully managed. The microphone access toggle exists on Android 12 and above.

Enums
MICROPHONE_ACCESS_UNSPECIFIEDIfunmuteMicrophoneDisabled is true, this is equivalent toMICROPHONE_ACCESS_DISABLED. Otherwise, this is equivalent toMICROPHONE_ACCESS_USER_CHOICE.
MICROPHONE_ACCESS_USER_CHOICEThe fieldunmuteMicrophoneDisabled is ignored. This is the default device behaviour: the microphone on the device is available. On Android 12 and above, the user can use the microphone access toggle.
MICROPHONE_ACCESS_DISABLED

The fieldunmuteMicrophoneDisabled is ignored. The microphone on the device is disabled (for fully managed devices, this applies device-wide).

The microphone access toggle has no effect as the microphone is disabled.

MICROPHONE_ACCESS_ENFORCEDThe fieldunmuteMicrophoneDisabled is ignored. The microphone on the device is available. On devices running Android 12 and above, the user is unable to use the microphone access toggle. On devices which run Android 11 or below, this is equivalent toMICROPHONE_ACCESS_USER_CHOICE.

DeviceConnectivityManagement

Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more.

JSON representation
{"usbDataAccess":enum (UsbDataAccess),"configureWifi":enum (ConfigureWifi),"wifiDirectSettings":enum (WifiDirectSettings),"tetheringSettings":enum (TetheringSettings),"wifiSsidPolicy":{object (WifiSsidPolicy)},"wifiRoamingPolicy":{object (WifiRoamingPolicy)},"bluetoothSharing":enum (BluetoothSharing),"preferentialNetworkServiceSettings":{object (PreferentialNetworkServiceSettings)},"apnPolicy":{object (ApnPolicy)}}
Fields
usbDataAccess

enum (UsbDataAccess)

Controls what files and/or data can be transferred via USB. Supported only on company-owned devices.

configureWifi

enum (ConfigureWifi)

Controls Wi-Fi configuring privileges. Based on the option set, user will have either full or limited or no control in configuring Wi-Fi networks.

wifiDirectSettings

enum (WifiDirectSettings)

Controls configuring and using Wi-Fi direct settings. Supported on company-owned devices running Android 13 and above.

tetheringSettings

enum (TetheringSettings)

Controls tethering settings. Based on the value set, the user is partially or fully disallowed from using different forms of tethering.

wifiSsidPolicy

object (WifiSsidPolicy)

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.

wifiRoamingPolicy

object (WifiRoamingPolicy)

Optional. Wi-Fi roaming policy.

bluetoothSharing

enum (BluetoothSharing)

Optional. Controls whether Bluetooth sharing is allowed.

preferentialNetworkServiceSettings

object (PreferentialNetworkServiceSettings)

Optional. Preferential network service configuration. Setting this field will overridepreferentialNetworkService. This can be set on both work profiles and fully managed devices on Android 13 and above. See5G network slicing guide for more details.

apnPolicy

object (ApnPolicy)

Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. SeeOVERRIDE_APNS_ENABLED andoverrideApns for details.

UsbDataAccess

Controls what files and/or data can be transferred via USB. Does not impact charging functions. Supported only on company-owned devices.

Enums
USB_DATA_ACCESS_UNSPECIFIEDUnspecified. Defaults toDISALLOW_USB_FILE_TRANSFER.
ALLOW_USB_DATA_TRANSFERAll types of USB data transfers are allowed.usbFileTransferDisabled is ignored.
DISALLOW_USB_FILE_TRANSFERTransferring files over USB is disallowed. Other types of USB data connections, such as mouse and keyboard connection, are allowed.usbFileTransferDisabled is ignored.
DISALLOW_USB_DATA_TRANSFERWhen set, all types of USB data transfers are prohibited. Supported for devices running Android 12 or above with USB HAL 1.3 or above. If the setting is not supported,DISALLOW_USB_FILE_TRANSFER will be set. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 12. ANonComplianceDetail withDEVICE_INCOMPATIBLE is reported if the device does not have USB HAL 1.3 or above.usbFileTransferDisabled is ignored.

ConfigureWifi

Controls Wi-Fi configuring privileges. Based on the option set, the user will have either full or limited or no control in configuring Wi-Fi networks.

Enums
CONFIGURE_WIFI_UNSPECIFIEDUnspecified. Defaults toALLOW_CONFIGURING_WIFI unlesswifiConfigDisabled is set to true. IfwifiConfigDisabled is set to true, this is equivalent toDISALLOW_CONFIGURING_WIFI.
ALLOW_CONFIGURING_WIFIThe user is allowed to configure Wi-Fi.wifiConfigDisabled is ignored.
DISALLOW_ADD_WIFI_CONFIGAdding new Wi-Fi configurations is disallowed. The user is only able to switch between already configured networks. Supported on Android 13 and above, on fully managed devices and work profiles on company-owned devices. If the setting is not supported,ALLOW_CONFIGURING_WIFI is set. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 13.wifiConfigDisabled is ignored.
DISALLOW_CONFIGURING_WIFIDisallows configuring Wi-Fi networks. The settingwifiConfigDisabled is ignored when this value is set. Supported on fully managed devices and work profile on company-owned devices, on all supported API levels. For fully managed devices, setting this removes all configured networks and retains only the networks configured usingopenNetworkConfiguration policy. For work profiles on company-owned devices, existing configured networks are not affected and the user is not allowed to add, remove, or modify Wi-Fi networks.Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (seenetworkEscapeHatchEnabled).

WifiDirectSettings

Controls Wi-Fi direct settings. Supported on company-owned devices running Android 13 and above.

Enums
WIFI_DIRECT_SETTINGS_UNSPECIFIEDUnspecified. Defaults toALLOW_WIFI_DIRECT
ALLOW_WIFI_DIRECTThe user is allowed to use Wi-Fi direct.
DISALLOW_WIFI_DIRECTThe user is not allowed to use Wi-Fi direct. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 13.

TetheringSettings

Controls the extent to which the user is allowed to use different forms of tethering like Wi-Fi tethering, bluetooth tethering, etc.

Enums
TETHERING_SETTINGS_UNSPECIFIEDUnspecified. Defaults toALLOW_ALL_TETHERING unlesstetheringConfigDisabled is set to true. IftetheringConfigDisabled is set to true, this is equivalent toDISALLOW_ALL_TETHERING.
ALLOW_ALL_TETHERINGAllows configuration and use of all forms of tethering.tetheringConfigDisabled is ignored.
DISALLOW_WIFI_TETHERINGDisallows the user from using Wi-Fi tethering. Supported on company owned devices running Android 13 and above. If the setting is not supported,ALLOW_ALL_TETHERING will be set. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 13.tetheringConfigDisabled is ignored.
DISALLOW_ALL_TETHERINGDisallows all forms of tethering. Supported on fully managed devices and work profile on company-owned devices, on all supported android versions. The settingtetheringConfigDisabled is ignored.

WifiSsidPolicy

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.

JSON representation
{"wifiSsidPolicyType":enum (WifiSsidPolicyType),"wifiSsids":[{object (WifiSsid)}]}
Fields
wifiSsidPolicyType

enum (WifiSsidPolicyType)

Type of the Wi-Fi SSID policy to be applied.

wifiSsids[]

object (WifiSsid)

Optional. List of Wi-Fi SSIDs that should be applied in the policy. This field must be non-empty when WifiSsidPolicyType is set toWIFI_SSID_ALLOWLIST. If this is set to a non-empty list, then aNonComplianceDetail detail withAPI_LEVEL is reported if the Android version is less than 13 and aNonComplianceDetail withMANAGEMENT_MODE is reported for non-company-owned devices.

WifiSsidPolicyType

The types of Wi-Fi SSID policy that can be applied on the device.

Enums
WIFI_SSID_POLICY_TYPE_UNSPECIFIEDDefaults toWIFI_SSID_DENYLIST.wifiSsids must not be set. There are no restrictions on which SSID the device can connect to.
WIFI_SSID_DENYLISTThe device cannot connect to any Wi-Fi network whose SSID is inwifiSsids, but can connect to other networks.
WIFI_SSID_ALLOWLISTThe device can make Wi-Fi connections only to the SSIDs inwifiSsids.wifiSsids must not be empty. The device will not be able to connect to any other Wi-Fi network.

WifiSsid

Represents a Wi-Fi SSID.

JSON representation
{"wifiSsid":string}
Fields
wifiSsid

string

Required. Wi-Fi SSID represented as a string.

WifiRoamingPolicy

Wi-Fi roaming policy.

JSON representation
{"wifiRoamingSettings":[{object (WifiRoamingSetting)}]}
Fields
wifiRoamingSettings[]

object (WifiRoamingSetting)

Optional. Wi-Fi roaming settings. SSIDs provided in this list must be unique, the policy will be rejected otherwise.

WifiRoamingSetting

Wi-Fi roaming setting.

JSON representation
{"wifiSsid":string,"wifiRoamingMode":enum (WifiRoamingMode)}
Fields
wifiSsid

string

Required. SSID of the Wi-Fi network.

wifiRoamingMode

enum (WifiRoamingMode)

Required. Wi-Fi roaming mode for the specified SSID.

WifiRoamingMode

Wi-Fi roaming mode.

Enums
WIFI_ROAMING_MODE_UNSPECIFIEDUnspecified. Defaults toWIFI_ROAMING_DEFAULT.
WIFI_ROAMING_DISABLEDWi-Fi roaming is disabled. Supported on Android 15 and above on fully managed devices and work profiles on company-owned devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for other management modes. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 15.
WIFI_ROAMING_DEFAULTDefault Wi-Fi roaming mode of the device.
WIFI_ROAMING_AGGRESSIVEAggressive roaming mode which allows quicker Wi-Fi roaming. Supported on Android 15 and above on fully managed devices and work profiles on company-owned devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for other management modes. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 15. ANonComplianceDetail withDEVICE_INCOMPATIBLE is reported if the device does not support aggressive roaming mode.

BluetoothSharing

Controls whether Bluetooth sharing is allowed.

Enums
BLUETOOTH_SHARING_UNSPECIFIEDUnspecified. Defaults toBLUETOOTH_SHARING_DISALLOWED on work profiles andBLUETOOTH_SHARING_ALLOWED on fully managed devices.
BLUETOOTH_SHARING_ALLOWED

Bluetooth sharing is allowed.

Supported on Android 8 and above. ANonComplianceDetail withAPI_LEVEL is reported on work profiles if the Android version is less than 8.

BLUETOOTH_SHARING_DISALLOWED

Bluetooth sharing is disallowed.

Supported on Android 8 and above. ANonComplianceDetail withAPI_LEVEL is reported on fully managed devices if the Android version is less than 8.

PreferentialNetworkServiceSettings

Preferential network service settings.

JSON representation
{"preferentialNetworkServiceConfigs":[{object (PreferentialNetworkServiceConfig)}],"defaultPreferentialNetworkId":enum (PreferentialNetworkId)}
Fields
preferentialNetworkServiceConfigs[]

object (PreferentialNetworkServiceConfig)

Required. Preferential network service configurations which enables having multiple enterprise slices. There must not be multiple configurations with the samepreferentialNetworkId. If a configuration is not referenced by any application by settingApplicationPolicy.preferentialNetworkId or by settingdefaultPreferentialNetworkId, it will be ignored. For devices on 4G networks, enterprise APN needs to be configured additionally to set up data call for preferential network service. These APNs can be added usingapnPolicy.

defaultPreferentialNetworkId

enum (PreferentialNetworkId)

Required. Default preferential network ID for the applications that are not inapplications or ifApplicationPolicy.preferentialNetworkId is set toPREFERENTIAL_NETWORK_ID_UNSPECIFIED. There must be a configuration for the specified network ID inpreferentialNetworkServiceConfigs, unless this is set toNO_PREFERENTIAL_NETWORK. If set toPREFERENTIAL_NETWORK_ID_UNSPECIFIED or unset, this defaults toNO_PREFERENTIAL_NETWORK. Note: If the default preferential network is misconfigured, applications with noApplicationPolicy.preferentialNetworkId set are not able to access the internet. This setting does not apply to the following critical apps:

  • com.google.android.apps.work.clouddpc
  • com.google.android.gms

ApplicationPolicy.preferentialNetworkId can still be used to configure the preferential network for them.

PreferentialNetworkServiceConfig

Individual preferential network service configuration.

JSON representation
{"preferentialNetworkId":enum (PreferentialNetworkId),"fallbackToDefaultConnection":enum (FallbackToDefaultConnection),"nonMatchingNetworks":enum (NonMatchingNetworks)}
Fields
preferentialNetworkId

enum (PreferentialNetworkId)

Required. Preferential network identifier. This must not be set toNO_PREFERENTIAL_NETWORK orPREFERENTIAL_NETWORK_ID_UNSPECIFIED, the policy will be rejected otherwise.

fallbackToDefaultConnection

enum (FallbackToDefaultConnection)

Optional. Whether fallback to the device-wide default network is allowed. If this is set toFALLBACK_TO_DEFAULT_CONNECTION_ALLOWED, thennonMatchingNetworks must not be set toNON_MATCHING_NETWORKS_DISALLOWED, the policy will be rejected otherwise. Note: If this is set toFALLBACK_TO_DEFAULT_CONNECTION_DISALLOWED, applications are not able to access the internet if the 5G slice is not available.

nonMatchingNetworks

enum (NonMatchingNetworks)

Optional. Whether apps this configuration applies to are blocked from using networks other than the preferential service. If this is set toNON_MATCHING_NETWORKS_DISALLOWED, thenfallbackToDefaultConnection must be set toFALLBACK_TO_DEFAULT_CONNECTION_DISALLOWED.

FallbackToDefaultConnection

Whether fallback to the device-wide default network is allowed. Note that while this setting determines whether the apps subject to this configuration have a default network in the absence of a preferential service, apps can still explicitly decide to use another network than their default network by requesting them from the system. This setting does not determine whether the apps are blocked from using such other networks. SeenonMatchingNetworks for this setting.

Enums
FALLBACK_TO_DEFAULT_CONNECTION_UNSPECIFIEDUnspecified. Defaults toFALLBACK_TO_DEFAULT_CONNECTION_ALLOWED.
FALLBACK_TO_DEFAULT_CONNECTION_ALLOWEDFallback to default connection is allowed. If this is set,nonMatchingNetworks must not be set toNON_MATCHING_NETWORKS_DISALLOWED, the policy will be rejected otherwise.
FALLBACK_TO_DEFAULT_CONNECTION_DISALLOWEDFallback to default connection is not allowed.

NonMatchingNetworks

Whether apps this configuration applies to are allowed to use networks other than the preferential service. Apps can inspect the list of available networks on the device and choose to use multiple networks concurrently for performance, privacy or other reasons.

Enums
NON_MATCHING_NETWORKS_UNSPECIFIEDUnspecified. Defaults toNON_MATCHING_NETWORKS_ALLOWED.
NON_MATCHING_NETWORKS_ALLOWEDApps this configuration applies to are allowed to use networks other than the preferential service.
NON_MATCHING_NETWORKS_DISALLOWEDApps this configuration applies to are disallowed from using other networks than the preferential service. This can be set on Android 14 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 14. If this is set,fallbackToDefaultConnection must be set toFALLBACK_TO_DEFAULT_CONNECTION_DISALLOWED, the policy will be rejected otherwise.

ApnPolicy

Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. SeeOVERRIDE_APNS_ENABLED andoverrideApns for details.

JSON representation
{"overrideApns":enum (OverrideApns),"apnSettings":[{object (ApnSetting)}]}
Fields
overrideApns

enum (OverrideApns)

Optional. Whether override APNs are disabled or enabled. SeeDevicePolicyManager.setOverrideApnsEnabled for more details.

apnSettings[]

object (ApnSetting)

Optional. APN settings for override APNs. There must not be any conflict between any of APN settings provided, otherwise the policy will be rejected. TwoApnSettings are considered to conflict when all of the following fields match on both:numericOperatorId,apn,proxyAddress,proxyPort,mmsProxyAddress,mmsProxyPort,mmsc,mvnoType,protocol,roamingProtocol. If some of the APN settings result in non-compliance ofINVALID_VALUE , they will be ignored. This can be set on fully managed devices on Android 10 and above. This can also be set on work profiles on Android 13 and above and only withApnSetting's withENTERPRISE APN type. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 10. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles on Android versions less than 13.

OverrideApns

Whether override APNs are disabled or enabled. SeeDevicePolicyManager.setOverrideApnsEnabled for more details.

Enums
OVERRIDE_APNS_UNSPECIFIEDUnspecified. Defaults toOVERRIDE_APNS_DISABLED.
OVERRIDE_APNS_DISABLEDOverride APNs disabled. Any configuredapnSettings are saved on the device, but are disabled and have no effect. Any other APNs on the device remain in use.
OVERRIDE_APNS_ENABLEDOverride APNs enabled. Only override APNs are in use, any other APNs are ignored. This can only be set on fully managed devices on Android 10 and above. For work profiles override APNs are enabled viapreferentialNetworkServiceSettings and this value cannot be set. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 10. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.

ApnSetting

An Access Point Name (APN) configuration for a carrier data connection. The APN provides configuration to connect a cellular network device to an IP data network. A carrier uses this setting to decide which IP address to assign, any security methods to apply, and how the device might be connected to private networks.

JSON representation
{"apnTypes":[enum (ApnType)],"apn":string,"displayName":string,"alwaysOnSetting":enum (AlwaysOnSetting),"authType":enum (AuthType),"carrierId":integer,"mmsProxyAddress":string,"mmsProxyPort":integer,"mmsc":string,"mtuV4":integer,"mtuV6":integer,"mvnoType":enum (MvnoType),"networkTypes":[enum (NetworkType)],"username":string,"password":string,"numericOperatorId":string,"protocol":enum (Protocol),"roamingProtocol":enum (Protocol),"proxyAddress":string,"proxyPort":integer}
Fields
apnTypes[]

enum (ApnType)

Required. Usage categories for the APN. Policy will be rejected if this field is empty or containsAPN_TYPE_UNSPECIFIED or duplicates. Multiple APN types can be set on fully managed devices.ENTERPRISE is the only allowed APN type on work profiles. ANonComplianceDetail withMANAGEMENT_MODE is reported for any other value on work profiles. APN types that are not supported on the device or management mode will be ignored. If this results in the empty list, the APN setting will be ignored, becauseapnTypes is a required field. ANonComplianceDetail withINVALID_VALUE is reported if none of the APN types are supported on the device or management mode.

apn

string

Required. Name of the APN. Policy will be rejected if this field is empty.

displayName

string

Required. Human-readable name that describes the APN. Policy will be rejected if this field is empty.

alwaysOnSetting

enum (AlwaysOnSetting)

Optional. Whether User Plane resources have to be activated during every transition from CM-IDLE mode to CM-CONNECTED state for this APN. See 3GPP TS 23.501 section 5.6.13.

authType

enum (AuthType)

Optional. Authentication type of the APN.

carrierId

integer

Optional. Carrier ID for the APN. A value of 0 (default) means not set and negative values are rejected.

mmsProxyAddress

string

Optional. MMS (Multimedia Messaging Service) proxy address of the APN which can be an IP address or hostname (not a URL).

mmsProxyPort

integer

Optional. MMS (Multimedia Messaging Service) proxy port of the APN. A value of 0 (default) means not set and negative values are rejected.

mmsc

string

Optional. MMSC (Multimedia Messaging Service Center) URI of the APN.

mtuV4

integer

Optional. The default MTU (Maximum Transmission Unit) size in bytes of the IPv4 routes brought up by this APN setting. A value of 0 (default) means not set and negative values are rejected. Supported on Android 13 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 13.

mtuV6

integer

Optional. The MTU (Maximum Transmission Unit) size of the IPv6 mobile interface to which the APN connected. A value of 0 (default) means not set and negative values are rejected. Supported on Android 13 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 13.

mvnoType

enum (MvnoType)

Optional. MVNO match type for the APN.

networkTypes[]

enum (NetworkType)

Optional. Radio technologies (network types) the APN may use. Policy will be rejected if this field containsNETWORK_TYPE_UNSPECIFIED or duplicates.

username

string

Optional. APN username of the APN.

password

string

Optional. APN password of the APN.

numericOperatorId

string

Optional. The numeric operator ID of the APN. Numeric operator ID is defined as MCC (Mobile Country Code) + MNC (Mobile Network Code).

protocol

enum (Protocol)

Optional. The protocol to use to connect to this APN.

roamingProtocol

enum (Protocol)

Optional. The protocol to use to connect to this APN while the device is roaming.

proxyAddress

string

Optional. The proxy address of the APN.

proxyPort

integer

Optional. The proxy port of the APN. A value of 0 (default) means not set and negative values are rejected.

ApnType

Usage category for the APN.

Enums
APN_TYPE_UNSPECIFIEDUnspecified. This value is not used.
ENTERPRISEAPN type for enterprise traffic. Supported on Android 13 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 13.
BIPAPN type for BIP (Bearer Independent Protocol). This can only be set on fully managed devices on Android 12 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 12. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
CBSAPN type for CBS (Carrier Branded Services). This can only be set on fully managed devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
DEFAULTAPN type for default data traffic. This can only be set on fully managed devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
DUNAPN type for DUN (Dial-up networking) traffic. This can only be set on fully managed devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
EMERGENCYAPN type for Emergency PDN. This is not an IA apn, but is used for access to carrier services in an emergency call situation. This can only be set on fully managed devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
FOTAAPN type for accessing the carrier's FOTA (Firmware Over-the-Air) portal, used for over the air updates. This can only be set on fully managed devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
HIPRIAPN type for HiPri (high-priority) traffic. This can only be set on fully managed devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
IAAPN type for IA (Initial Attach) APN. This can only be set on fully managed devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
IMSAPN type for IMS (IP Multimedia Subsystem) traffic. This can only be set on fully managed devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
MCXAPN type for MCX (Mission Critical Service) where X can be PTT/Video/Data. This can only be set on fully managed devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
MMSAPN type for MMS (Multimedia Messaging Service) traffic. This can only be set on fully managed devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
RCSAPN type for RCS (Rich Communication Services). This can only be set on fully managed devices on Android 15 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 15. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
SUPLAPN type for SUPL (Secure User Plane Location) assisted GPS. This can only be set on fully managed devices. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
VSIMAPN type for VSIM (Virtual SIM) service. This can only be set on fully managed devices on Android 12 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 12. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.
XCAPAPN type for XCAP (XML Configuration Access Protocol) traffic. This can only be set on fully managed devices on Android 11 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 11. ANonComplianceDetail withMANAGEMENT_MODE is reported for work profiles.

AlwaysOnSetting

Whether User Plane resources have to be activated during every transition from CM-IDLE mode to CM-CONNECTED state for this APN. See 3GPP TS 23.501 section 5.6.13.

Enums
ALWAYS_ON_SETTING_UNSPECIFIEDUnspecified. Defaults toNOT_ALWAYS_ON.
NOT_ALWAYS_ONThe PDU session brought up by this APN should not be always on.
ALWAYS_ONThe PDU session brought up by this APN should always be on. Supported on Android 15 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 15.

AuthType

Authentication type of the APN.

Enums
AUTH_TYPE_UNSPECIFIEDUnspecified. Ifusername is empty, defaults toNONE. Otherwise, defaults toPAP_OR_CHAP.
NONEAuthentication is not required.
PAPAuthentication type for PAP.
CHAPAuthentication type for CHAP.
PAP_OR_CHAPAuthentication type for PAP or CHAP.

MvnoType

MVNO match type for the APN.

Enums
MVNO_TYPE_UNSPECIFIEDThe MVNO type is not specified.
GIDMVNO type for group identifier level 1.
ICCIDMVNO type for ICCID.
IMSIMVNO type for IMSI.
SPNMVNO type for SPN (service provider name).

NetworkType

Radio technology (network type) the APN may use.

Enums
NETWORK_TYPE_UNSPECIFIEDUnspecified. This value must not be used.
EDGERadio technology EDGE.
GPRSRadio technology GPRS.
GSMRadio technology GSM.
HSDPARadio technology HSDPA.
HSPARadio technology HSPA.
HSPAPRadio technology HSPAP.
HSUPARadio technology HSUPA.
IWLANRadio technology IWLAN.
LTERadio technology LTE.
NRRadio technology NR (New Radio) 5G.
TD_SCDMARadio technology TD_SCDMA.
UMTSRadio technology UMTS.

Protocol

The protocol to use to connect to the APN.

Enums
PROTOCOL_UNSPECIFIEDThe protocol is not specified.
IPInternet protocol.
IPV4V6Virtual PDP type introduced to handle dual IP stack UE capability.
IPV6Internet protocol, version 6.
NON_IPTransfer of Non-IP data to external packet data network.
PPPPoint to point protocol.
UNSTRUCTUREDTransfer of Unstructured data to the Data Network via N6.

DeviceRadioState

Controls for device radio settings.

JSON representation
{"wifiState":enum (WifiState),"airplaneModeState":enum (AirplaneModeState),"ultraWidebandState":enum (UltraWidebandState),"cellularTwoGState":enum (CellularTwoGState),"minimumWifiSecurityLevel":enum (MinimumWifiSecurityLevel)}
Fields
wifiState

enum (WifiState)

Controls current state of Wi-Fi and if user can change its state.

airplaneModeState

enum (AirplaneModeState)

Controls whether airplane mode can be toggled by the user or not.

ultraWidebandState

enum (UltraWidebandState)

Controls the state of the ultra wideband setting and whether the user can toggle it on or off.

cellularTwoGState

enum (CellularTwoGState)

Controls whether cellular 2G setting can be toggled by the user or not.

minimumWifiSecurityLevel

enum (MinimumWifiSecurityLevel)

The minimum required security level of Wi-Fi networks that the device can connect to.

WifiState

Controls whether the Wi-Fi is on or off as a state and if the user can change said state. Supported on company-owned devices running Android 13 and above.

Enums
WIFI_STATE_UNSPECIFIEDUnspecified. Defaults toWIFI_STATE_USER_CHOICE
WIFI_STATE_USER_CHOICEUser is allowed to enable/disable Wi-Fi.
WIFI_ENABLEDWi-Fi is on and the user is not allowed to turn it off. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 13.
WIFI_DISABLEDWi-Fi is off and the user is not allowed to turn it on. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 13.

AirplaneModeState

Controls the state of airplane mode and whether the user can toggle it on or off. Supported on Android 9 and above. Supported on fully managed devices and work profiles on company-owned devices.

Enums
AIRPLANE_MODE_STATE_UNSPECIFIEDUnspecified. Defaults toAIRPLANE_MODE_USER_CHOICE.
AIRPLANE_MODE_USER_CHOICEThe user is allowed to toggle airplane mode on or off.
AIRPLANE_MODE_DISABLEDAirplane mode is disabled. The user is not allowed to toggle airplane mode on. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 9.

UltraWidebandState

Controls the state of the ultra wideband setting and whether the user can toggle it on or off. Supported on Android 14 and above. Supported on fully managed devices and work profiles on company-owned devices.

Enums
ULTRA_WIDEBAND_STATE_UNSPECIFIEDUnspecified. Defaults toULTRA_WIDEBAND_USER_CHOICE.
ULTRA_WIDEBAND_USER_CHOICEThe user is allowed to toggle ultra wideband on or off.
ULTRA_WIDEBAND_DISABLEDUltra wideband is disabled. The user is not allowed to toggle ultra wideband on via settings. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 14.

CellularTwoGState

Controls the state of cellular 2G setting and whether the user can toggle it on or off. Supported on Android 14 and above. Supported on fully managed devices and work profiles on company-owned devices.

Enums
CELLULAR_TWO_G_STATE_UNSPECIFIEDUnspecified. Defaults toCELLULAR_TWO_G_USER_CHOICE.
CELLULAR_TWO_G_USER_CHOICEThe user is allowed to toggle cellular 2G on or off.
CELLULAR_TWO_G_DISABLEDCellular 2G is disabled. The user is not allowed to toggle cellular 2G on via settings. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 14.

MinimumWifiSecurityLevel

Defines the different minimum Wi-Fi security levels required to connect to Wi-Fi networks. Supported on Android 13 and above. Supported on fully managed devices and work profiles on company-owned devices.

Enums
MINIMUM_WIFI_SECURITY_LEVEL_UNSPECIFIEDDefaults toOPEN_NETWORK_SECURITY, which means the device will be able to connect to all types of Wi-Fi networks.
OPEN_NETWORK_SECURITYThe device will be able to connect to all types of Wi-Fi networks.
PERSONAL_NETWORK_SECURITYA personal network such as WEP, WPA2-PSK is the minimum required security. The device will not be able to connect to open wifi networks. This is stricter thanOPEN_NETWORK_SECURITY. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 13.
ENTERPRISE_NETWORK_SECURITYAn enterprise EAP network is the minimum required security level. The device will not be able to connect to Wi-Fi network below this security level. This is stricter thanPERSONAL_NETWORK_SECURITY. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 13.
ENTERPRISE_BIT192_NETWORK_SECURITYA 192-bit enterprise network is the minimum required security level. The device will not be able to connect to Wi-Fi network below this security level. This is stricter thanENTERPRISE_NETWORK_SECURITY. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 13.

CredentialProviderPolicyDefault

Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, seethis andthis for details. See alsocredentialProviderPolicy.

Enums
CREDENTIAL_PROVIDER_POLICY_DEFAULT_UNSPECIFIEDUnspecified. Defaults to CREDENTIAL_PROVIDER_DEFAULT_DISALLOWED.
CREDENTIAL_PROVIDER_DEFAULT_DISALLOWEDApps withcredentialProviderPolicy unspecified are not allowed to act as a credential provider.
CREDENTIAL_PROVIDER_DEFAULT_DISALLOWED_EXCEPT_SYSTEMApps withcredentialProviderPolicy unspecified are not allowed to act as a credential provider except for the OEM default credential providers. OEM default credential providers are always allowed to act as credential providers.

PrintingPolicy

Controls whether printing is allowed. This is supported on devices running Android 9 and above.

Enums
PRINTING_POLICY_UNSPECIFIEDUnspecified. Defaults toPRINTING_ALLOWED.
PRINTING_DISALLOWEDPrinting is disallowed. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 9.
PRINTING_ALLOWEDPrinting is allowed.

DisplaySettings

Controls for the display settings.

JSON representation
{"screenBrightnessSettings":{object (ScreenBrightnessSettings)},"screenTimeoutSettings":{object (ScreenTimeoutSettings)}}
Fields
screenBrightnessSettings

object (ScreenBrightnessSettings)

Optional. Controls the screen brightness settings.

screenTimeoutSettings

object (ScreenTimeoutSettings)

Optional. Controls the screen timeout settings.

ScreenBrightnessSettings

Controls for the screen brightness settings.

JSON representation
{"screenBrightnessMode":enum (ScreenBrightnessMode),"screenBrightness":integer}
Fields
screenBrightnessMode

enum (ScreenBrightnessMode)

Optional. Controls the screen brightness mode.

screenBrightness

integer

Optional. The screen brightness between 1 and 255 where 1 is the lowest and 255 is the highest brightness. A value of 0 (default) means no screen brightness set. Any other value is rejected.screenBrightnessMode must be eitherBRIGHTNESS_AUTOMATIC orBRIGHTNESS_FIXED to set this. Supported on Android 9 and above on fully managed devices. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 9. Supported on work profiles on company-owned devices on Android 15 and above.

ScreenBrightnessMode

Controls the screen brightness mode.

Enums
SCREEN_BRIGHTNESS_MODE_UNSPECIFIEDUnspecified. Defaults toBRIGHTNESS_USER_CHOICE.
BRIGHTNESS_USER_CHOICEThe user is allowed to configure the screen brightness.screenBrightness must not be set.
BRIGHTNESS_AUTOMATICThe screen brightness mode is automatic in which the brightness is automatically adjusted and the user is not allowed to configure the screen brightness.screenBrightness can still be set and it is taken into account while the brightness is automatically adjusted. Supported on Android 9 and above on fully managed devices. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 9. Supported on work profiles on company-owned devices on Android 15 and above.
BRIGHTNESS_FIXEDThe screen brightness mode is fixed in which the brightness is set toscreenBrightness and the user is not allowed to configure the screen brightness.screenBrightness must be set. Supported on Android 9 and above on fully managed devices. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 9. Supported on work profiles on company-owned devices on Android 15 and above.

ScreenTimeoutSettings

Controls the screen timeout settings.

JSON representation
{"screenTimeoutMode":enum (ScreenTimeoutMode),"screenTimeout":string}
Fields
screenTimeoutMode

enum (ScreenTimeoutMode)

Optional. Controls whether the user is allowed to configure the screen timeout.

screenTimeout

string (Duration format)

Optional. Controls the screen timeout duration. The screen timeout duration must be greater than 0, otherwise it is rejected. Additionally, it should not be greater thanmaximumTimeToLock, otherwise the screen timeout is set tomaximumTimeToLock and aNonComplianceDetail withINVALID_VALUE reason andSCREEN_TIMEOUT_GREATER_THAN_MAXIMUM_TIME_TO_LOCK specific reason is reported. If the screen timeout is less than a certain lower bound, it is set to the lower bound. The lower bound may vary across devices. If this is set,screenTimeoutMode must beSCREEN_TIMEOUT_ENFORCED. Supported on Android 9 and above on fully managed devices. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 9. Supported on work profiles on company-owned devices on Android 15 and above.

A duration in seconds with up to nine fractional digits, ending with 's'. Example:"3.5s".

ScreenTimeoutMode

Controls whether the user is allowed to configure the screen timeout.

Enums
SCREEN_TIMEOUT_MODE_UNSPECIFIEDUnspecified. Defaults toSCREEN_TIMEOUT_USER_CHOICE.
SCREEN_TIMEOUT_USER_CHOICEThe user is allowed to configure the screen timeout.screenTimeout must not be set.
SCREEN_TIMEOUT_ENFORCEDThe screen timeout is set toscreenTimeout and the user is not allowed to configure the timeout.screenTimeout must be set. Supported on Android 9 and above on fully managed devices. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 9. Supported on work profiles on company-owned devices on Android 15 and above.

AssistContentPolicy

Controls whetherAssistContent is allowed to be sent to a privileged app such as an assistant app. AssistContent includes screenshots and information about an app, such as package name. This is supported on Android 15 and above.

Enums
ASSIST_CONTENT_POLICY_UNSPECIFIEDUnspecified. Defaults toASSIST_CONTENT_ALLOWED.
ASSIST_CONTENT_DISALLOWED

Assist content is blocked from being sent to a privileged app.

Supported on Android 15 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 15.

ASSIST_CONTENT_ALLOWED

Assist content is allowed to be sent to a privileged app.

Supported on Android 15 and above.

WorkAccountSetupConfig

Controls the work account setup configuration, such as details of whether a Google authenticated account is required.

JSON representation
{"authenticationType":enum (AuthenticationType),"requiredAccountEmail":string}
Fields
authenticationType

enum (AuthenticationType)

Optional. The authentication type of the user on the device.

requiredAccountEmail

string

Optional. The specific google work account email address to be added. This field is only relevant ifauthenticationType isGOOGLE_AUTHENTICATED. This must be an enterprise account and not a consumer account. Once set and a Google authenticated account is added to the device, changing this field will have no effect, and thus recommended to be set only once.

AuthenticationType

The authentication type of the user on the device.

Enums
AUTHENTICATION_TYPE_UNSPECIFIEDUnspecified. Defaults toAUTHENTICATION_TYPE_NOT_ENFORCED.
AUTHENTICATION_TYPE_NOT_ENFORCEDAuthentication status of user on device is not enforced.
GOOGLE_AUTHENTICATEDRequires device to be managed with a Google authenticated account.

WipeDataFlag

Wipe flags to indicate what data is wiped when a device or profile wipe is triggered due to any reason. (For example, when the device is non-compliant). This does not apply to theenterprises.devices.delete method.

Enums
WIPE_DATA_FLAG_UNSPECIFIEDThis value must not be used.
WIPE_ESIMSFor company-owned devices, setting this inwipeDataFlags will remove all eSIMs on the device when wipe is triggered due to any reason. On personally-owned devices, this will remove only managed eSIMs on the device. (eSIMs which are added via theADD_ESIM command). This is supported on devices running Android 15 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 15.

EnterpriseDisplayNameVisibility

Controls whether theenterpriseDisplayName is visible on the device (e.g. lock screen message on company-owned devices).

Enums
ENTERPRISE_DISPLAY_NAME_VISIBILITY_UNSPECIFIEDUnspecified. Defaults to displaying the enterprise name that's set at the time of device setup. In future, this will default toENTERPRISE_DISPLAY_NAME_VISIBLE.
ENTERPRISE_DISPLAY_NAME_VISIBLEThe enterprise display name is visible on the device. Supported on work profiles on Android 7 and above. Supported on fully managed devices on Android 8 and above. ANonComplianceDetail withAPI_LEVEL is reported if the Android version is less than 7. ANonComplianceDetail withMANAGEMENT_MODE is reported on fully managed devices on Android 7.
ENTERPRISE_DISPLAY_NAME_HIDDENThe enterprise display name is hidden on the device.

AppFunctions

Controls whether apps on the device for fully managed devices or in the work profile for devices with work profiles are allowed to expose app functions.

Enums
APP_FUNCTIONS_UNSPECIFIEDUnspecified. Defaults toAPP_FUNCTIONS_ALLOWED.
APP_FUNCTIONS_DISALLOWEDApps on the device for fully managed devices or in the work profile for devices with work profiles are not allowed to expose app functions. If this is set,crossProfileAppFunctions must not be set toCROSS_PROFILE_APP_FUNCTIONS_ALLOWED, otherwise the policy will be rejected.
APP_FUNCTIONS_ALLOWEDApps on the device for fully managed devices or in the work profile for devices with work profiles are allowed to expose app functions.

DefaultApplicationSetting

The default application setting for aDefaultApplicationType.

JSON representation
{"defaultApplicationType":enum (DefaultApplicationType),"defaultApplications":[{object (DefaultApplication)}],"defaultApplicationScopes":[enum (DefaultApplicationScope)]}
Fields
defaultApplicationType

enum (DefaultApplicationType)

Required. The app type to set the default application.

defaultApplications[]

object (DefaultApplication)

Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for thedefaultApplicationType (e.g. SMS app forDEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries inApplicationPolicy.signingKeyCerts in order to be set as the default.

If thedefaultApplicationScopes containsSCOPE_FULLY_MANAGED orSCOPE_WORK_PROFILE, the app must have an entry inapplications withinstallType set to a value other thanBLOCKED.

ANonComplianceDetail withAPP_NOT_INSTALLED reason andDEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported ifnone of the apps in the list are installed. ANonComplianceDetail withINVALID_VALUE reason andDEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).

When applying toSCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. ANonComplianceDetail withINVALID_VALUE reason andDEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile.

defaultApplicationScopes[]

enum (DefaultApplicationScope)

Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.

ANonComplianceDetail withMANAGEMENT_MODE reason andDEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported ifnone of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with onlySCOPE_PERSONAL_PROFILE in the list).

DefaultApplication

Information about the application to be set as the default.

JSON representation
{"packageName":string}
Fields
packageName

string

Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid.

Methods

delete

Deletes a policy.

get

Gets a policy.

list

Lists policies for a given enterprise.

modifyPolicyApplications

Updates or creates applications in a policy.

patch

Updates or creates a policy.

removePolicyApplications

Removes applications in a policy.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-11-20 UTC.