REST Resource: enterprises.policies

{
  "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)
}

string

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

string (int64 format)

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

object (ApplicationPolicy)

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

string (int64 format)

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

boolean

Whether screen capture is disabled.

boolean

If cameraAccess is set to any value other than CAMERA_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.

enum (KeyguardDisabledFeature)

Disabled keyguard customizations, such as widgets.

enum (PermissionPolicy)

The default permission policy for runtime permission requests.

object (PersistentPreferredActivity)

Default intent handler activities.

object (Struct format)

Network configuration for the device. See configure networks for more information.

object (SystemUpdate)

The system update policy, which controls how OS updates are applied. If the update type is WINDOWED, 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 in Manage system updates for further details.

string

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

boolean

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

boolean

Whether adjusting the master volume is disabled. Also mutes the device.

boolean

Whether factory resetting from settings is disabled.

boolean

Whether user installation of apps is disabled.

boolean

Whether the user mounting physical external media is disabled.

boolean

Whether adding or removing accounts is disabled.

boolean

Whether rebooting the device into safe boot is disabled.

boolean

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

boolean

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, use InstallType KIOSK or kioskCustomLauncherEnabled.

boolean

If true, this disables the Lock Screen for primary and/or secondary displays.

integer

The minimum allowed Android API level.

object (StatusReportingSettings)

Status reporting settings

boolean

Whether bluetooth contact sharing is disabled.

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.

object (UserFacingMessage)

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

object (PasswordRequirements)

Password requirements. The field passwordRequirements.require_password_unlock must not be set. DEPRECATED - Use passwordPolicies.

Note:

Complexity-based values of PasswordQuality, that is, COMPLEXITY_LOW, COMPLEXITY_MEDIUM, and COMPLEXITY_HIGH, cannot be used here. unifiedLockSettings cannot be used here.

boolean

This is deprecated.

boolean

Whether configuring bluetooth is disabled.

boolean

Whether configuring cell broadcast is disabled.

boolean

Whether configuring user credentials is disabled.

boolean

Whether configuring mobile networks is disabled.

boolean

Whether configuring tethering and portable hotspots is disabled. If tetheringSettings is set to anything other than TETHERING_SETTINGS_UNSPECIFIED, this setting is ignored.

boolean

Whether configuring VPN is disabled.

boolean

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 using openNetworkConfiguration. 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. If configureWifi is set to anything other than CONFIGURE_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 (see networkEscapeHatchEnabled).

boolean

Whether creating windows besides app windows is disabled.

boolean

Whether resetting network settings is disabled.

boolean

Whether using NFC to beam data from apps is disabled.

boolean

Whether outgoing calls are disabled.

boolean

Whether removing other users is disabled.

boolean

Whether location sharing is disabled. shareLocationDisabled is supported for both fully managed devices and personally owned work profiles.

boolean

Whether sending and receiving SMS messages is disabled.

boolean

If microphoneAccess is set to any value other than MICROPHONE_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.

boolean

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

boolean

Whether app verification is force-enabled.

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.

enum (BatteryPluggedMode)

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

object (ProxyInfo)

The network-independent global HTTP proxy. Typically proxies should be configured per-network in openNetworkConfiguration. 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.

boolean

Whether changing the user icon is disabled.

boolean

Whether changing the wallpaper is disabled.

object (ChoosePrivateKeyRule)

Rules for determining apps' access to private keys. See ChoosePrivateKeyRule for details. This must be empty if any application has CERT_SELECTION delegation scope.

object (AlwaysOnVpnPackage)

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

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.

object (UserFacingMessage)

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

boolean

Whether roaming data services are disabled.

enum (LocationMode)

The degree of location detection enabled.

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: Setting wifiConfigDisabled to true will override this setting under specific circumstances. Please see wifiConfigDisabled for further details. Setting configureWifi to DISALLOW_CONFIGURING_WIFI will override this setting under specific circumstances. Please see DISALLOW_CONFIGURING_WIFI for further details.

boolean

Whether bluetooth is disabled. Prefer this setting over bluetoothConfigDisabled because bluetoothConfigDisabled can be bypassed by the user.

object (ComplianceRule)

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.

boolean

Whether applications other than the ones configured in applications 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.

boolean

This field has no effect.

boolean

Whether the user is allowed to enable debugging features.

boolean

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

boolean

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

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.

enum (AppAutoUpdatePolicy)

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

When autoUpdateMode is set to AUTO_UPDATE_POSTPONED or AUTO_UPDATE_HIGH_PRIORITY, this field has no effect.

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

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 the applications setting. Apps appear on a single page in alphabetical order. Use kioskCustomization to further configure the kiosk device behavior.

enum (AppTrack)

This setting is not supported. Any value is ignored.

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.

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 has CERT_SELECTION delegation scope.

enum (EncryptionPolicy)

Whether encryption is enabled

boolean

Whether USB storage is enabled. Deprecated.

object (PermissionGrant)

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

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.

object (SetupAction)

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

object (PasswordRequirements)

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

object (PolicyEnforcementRule)

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

object (KioskCustomization)

Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK.

object (AdvancedSecurityOverrides)

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

object (PersonalUsagePolicies)

Policies managing personal usage on a company-owned device.

enum (AutoDateAndTimeZone)

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

object (OncCertificateProvider)

This feature is not generally available.

object (CrossProfilePolicies)

Cross-profile policies applied on the device.

enum (PreferentialNetworkService)

Controls whether preferential network service is enabled on the work profile. 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 has no effect on fully managed devices.

object (UsageLog)

Configuration of device activity logging.

enum (CameraAccess)

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

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.

object (DeviceConnectivityManagement)

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

object (DeviceRadioState)

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

enum (CredentialProviderPolicyDefault)

Controls which apps are allowed to act as credential providers on Android 14 and above. These apps store credentials, see this and this for details. See also credentialProviderPolicy.

enum (PrintingPolicy)

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

object (DisplaySettings)

Optional. Controls for the display settings.

enum (AssistContentPolicy)

Optional. Controls whether AssistContent 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.

{
  "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),
  "installConstraint": [
    {
      object (InstallConstraint)
    }
  ],
  "installPriority": integer,
  "userControlSettings": enum (UserControlSettings)
}

string

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

enum (InstallType)

The type of installation to perform.

boolean

Whether the app is allowed to lock itself in full-screen mode. DEPRECATED. Use InstallType KIOSK or kioskCustomLauncherEnabled to configure a dedicated device.

enum (PermissionPolicy)

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

object (PermissionGrant)

Explicit permission grants or denials for the app. These values override the defaultPermissionPolicy and permissionGrants which apply to all apps.

object (Struct format)

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

boolean

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

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 a NonComplianceDetail with nonComplianceReason set to APP_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.

enum (DelegatedScope)

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

object (ManagedConfigurationTemplate)

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

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 in AppTrackInfo.

enum (ConnectedWorkAndPersonalApp)

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

enum (AutoUpdateMode)

Controls the auto-update mode for the app.

object (ExtensionConfig)

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.

enum (AlwaysOnVpnLockdownExemption)

Specifies whether the app is allowed networking when the VPN is not connected and alwaysOnVpnPackage.lockdownEnabled is enabled. If set to VPN_LOCKDOWN_ENFORCED, the app is not allowed networking, and if set to VPN_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 a NonComplianceDetail with nonComplianceReason set to API_LEVEL and a fieldPath. If this is not applicable to the app, the device will contain a NonComplianceDetail with nonComplianceReason set to UNSUPPORTED and a fieldPath. The fieldPath is set to applications[i].alwaysOnVpnLockdownExemption, where i is the index of the package in the applications policy.

enum (WorkProfileWidgets)

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

enum (CredentialProviderPolicy)

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

object (InstallConstraint)

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

integer

Optional. Amongst apps with installType set to:

• FORCE_INSTALLED
• PREINSTALLED

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.

enum (UserControlSettings)

Optional. Specifies whether user control is permitted for the app. User control includes user actions like force-stopping and clearing app data. Supported on Android 11 and above.

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

string

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

enum (PermissionPolicy)

The policy for granting the permission.

{
  "templateId": string,
  "configurationVariables": {
    string: string,
    ...
  }
}

string

The ID of the managed configurations template.

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" }.

{
  "signingKeyFingerprintsSha256": [
    string
  ],
  "notificationReceiver": string
}

string

Hex-encoded SHA-256 hash of the signing certificate of the extension app. Only hexadecimal string representations of 64 characters are valid.

If not specified, the signature for the corresponding package name is obtained from the Play Store instead.

If this list is empty, the signature of the extension app on the device must match the signature obtained from the Play Store for the app to be able to communicate with Android Device Policy.

If this list is not empty, the signature of the extension app on the device must match one of the entries in this list for the app to be able to communicate with Android Device Policy.

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

string

Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates.

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

enum (NetworkTypeConstraint)

Optional. Network type constraint.

enum (ChargingConstraint)

Optional. Charging constraint.

enum (DeviceIdleConstraint)

Optional. Device idle constraint.

{
  "receiverActivity": string,
  "actions": [
    string
  ],
  "categories": [
    string
  ]
}

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.

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.

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.

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

enum (SystemUpdateType)

The type of system update to configure.

integer

If the type is WINDOWED, 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.

integer

If the type is WINDOWED, 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 than startMinutes, 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.

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.

{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}

object (Date)

The start date (inclusive) of the freeze period. Note: year must not be set. For example, {"month": 1,"date": 30}.

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: year must not be set. For example, {"month": 1,"date": 30}.

{
  "year": integer,
  "month": integer,
  "day": integer
}

integer

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

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and 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.

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

boolean

Whether app reports are enabled.

boolean

Whether device settings reporting is enabled.

boolean

Whether software info reporting is enabled.

boolean

Whether memory event reporting is enabled.

boolean

Whether network info reporting is enabled.

boolean

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

boolean

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

boolean

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

boolean

Whether system properties reporting is enabled.

object (ApplicationReportingSettings)

Application reporting settings. Only applicable if applicationReportsEnabled is true.

boolean

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

{
  "includeRemovedApps": boolean
}

boolean

Whether removed apps are included in application reports.

{
  "packageNames": [
    string
  ]
}

string

A list of package names.

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

string

The host of the direct proxy.

integer

The port of the direct proxy.

string

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

string

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

{
  "urlPattern": string,
  "packageNames": [
    string
  ],
  "privateKeyAlias": string
}

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 of java.util.regex.Pattern.

string

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

string

The alias of the private key to be used.

{
  "packageName": string,
  "lockdownEnabled": boolean
}

string

The package name of the VPN app.

boolean

Disallows networking when the VPN is not connected.

{
  "disableApps": boolean,
  "packageNamesToDisable": [
    string
  ],

  // Union field condition can be only one of the following:
  "nonComplianceDetailCondition": {
    object (NonComplianceDetailCondition)
  },
  "apiLevelCondition": {
    object (ApiLevelCondition)
  }
  // End of list of possible types for union field condition.
}

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.

string

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

object (NonComplianceDetailCondition)

A condition which is satisfied if there exists any matching NonComplianceDetail for the device.

object (ApiLevelCondition)

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

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

string

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

enum (NonComplianceReason)

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

string

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

{
  "minApiLevel": integer
}

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.

{
  "title": {
    object (UserFacingMessage)
  },
  "description": {
    object (UserFacingMessage)
  },

  // Union field action can be only one of the following:
  "launchApp": {
    object (LaunchAppAction)
  }
  // End of list of possible types for union field action.
}

object (UserFacingMessage)

Title of this action.

object (UserFacingMessage)

Description of this action.

object (LaunchAppAction)

An action to launch an app. The app will be launched with an intent containing an extra with key com.google.android.apps.work.clouddpc.EXTRA_LAUNCHED_AS_SETUP_ACTION set to the boolean value true to indicate that this is a setup action flow. If SetupAction references an app, the corresponding installType in the application policy must be set as REQUIRED_FOR_SETUP or said setup will fail.

{

  // Union field launch can be only one of the following:
  "packageName": string
  // End of list of possible types for union field launch.
}

string

Package name of app to be launched

{
  "blockAction": {
    object (BlockAction)
  },
  "wipeAction": {
    object (WipeAction)
  },

  // Union field trigger can be only one of the following:
  "settingName": string
  // End of list of possible types for union field trigger.
}

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.

object (WipeAction)

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

string

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

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

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 than wipeAfterDays.

enum (BlockScope)

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

{
  "wipeAfterDays": integer,
  "preserveFrp": boolean
}

integer

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

boolean

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

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

enum (PowerButtonActions)

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

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.

enum (SystemNavigation)

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

enum (StatusBar)

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

enum (DeviceSettings)

Specifies whether the Settings app is allowed in kiosk mode.

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

enum (UntrustedAppsPolicy)

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

enum (GooglePlayProtectVerifyApps)

Whether Google Play Protect verification is enforced. Replaces ensureVerifyAppsEnabled (deprecated).

enum (DeveloperSettings)

Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated).

enum (CommonCriteriaMode)

Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode 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.

string

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

enum (MtePolicy)

Optional. Controls Memory Tagging Extension (MTE) on the device. The device needs to be rebooted to apply changes to the MTE policy.

enum (ContentProtectionPolicy)

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

{
  "cameraDisabled": boolean,
  "screenCaptureDisabled": boolean,
  "accountTypesWithManagementDisabled": [
    string
  ],
  "maxDaysWithWorkOff": integer,
  "personalPlayStoreMode": enum (PlayStoreMode),
  "personalApplications": [
    {
      object (PersonalApplicationPolicy)
    }
  ]
}

boolean

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

boolean

If true, screen capture is disabled for all users.

string

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

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.

enum (PlayStoreMode)

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

object (PersonalApplicationPolicy)

Policy applied to applications in the personal profile.

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

string

The package name of the application.

enum (InstallType)

The type of installation to perform.

{
  "certificateReferences": [
    string
  ],

  // Union field endpoint can be only one of the following:
  "contentProviderEndpoint": {
    object (ContentProviderEndpoint)
  }
  // End of list of possible types for union field endpoint.
}

string

This feature is not generally available.

object (ContentProviderEndpoint)

This feature is not generally available.

{
  "uri": string,
  "packageName": string,
  "signingCertsSha256": [
    string
  ]
}

string

This feature is not generally available.

string

This feature is not generally available.

string

Required. This feature is not generally available.

{
  "showWorkContactsInPersonalProfile": enum (ShowWorkContactsInPersonalProfile),
  "crossProfileCopyPaste": enum (CrossProfileCopyPaste),
  "crossProfileDataSharing": enum (CrossProfileDataSharing),
  "workProfileWidgetsDefault": enum (WorkProfileWidgetsDefault),
  "exemptionsToShowWorkContactsInPersonalProfile": {
    object (PackageNameList)
  }
}

enum (ShowWorkContactsInPersonalProfile)

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

See also exemptionsToShowWorkContactsInPersonalProfile.

enum (CrossProfileCopyPaste)

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

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.

enum (WorkProfileWidgetsDefault)

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

object (PackageNameList)

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

• SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist.
• SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist.
• SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.

Supported on Android 14 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 14.

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

enum (LogType)

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

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.

{
  "usbDataAccess": enum (UsbDataAccess),
  "configureWifi": enum (ConfigureWifi),
  "wifiDirectSettings": enum (WifiDirectSettings),
  "tetheringSettings": enum (TetheringSettings),
  "wifiSsidPolicy": {
    object (WifiSsidPolicy)
  },
  "wifiRoamingPolicy": {
    object (WifiRoamingPolicy)
  }
}

enum (UsbDataAccess)

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

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.

enum (WifiDirectSettings)

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

enum (TetheringSettings)

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

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.

object (WifiRoamingPolicy)

Optional. Wi-Fi roaming policy.

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

enum (WifiSsidPolicyType)

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

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 to WIFI_SSID_ALLOWLIST. If this is set to a non-empty list, then a nonComplianceDetail detail with API_LEVEL is reported if the Android version is less than 13 and a nonComplianceDetail with MANAGEMENT_MODE is reported for non-company-owned devices.

{
  "wifiSsid": string
}

string

Required. Wi-Fi SSID represented as a string.

{
  "wifiRoamingSettings": [
    {
      object (WifiRoamingSetting)
    }
  ]
}

object (WifiRoamingSetting)

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

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

string

Required. SSID of the Wi-Fi network.

enum (WifiRoamingMode)

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

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

enum (WifiState)

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

enum (AirplaneModeState)

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

enum (UltraWidebandState)

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

enum (CellularTwoGState)

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

enum (MinimumWifiSecurityLevel)

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

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

object (ScreenBrightnessSettings)

Optional. Controls the screen brightness settings.

object (ScreenTimeoutSettings)

Optional. Controls the screen timeout settings.

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

enum (ScreenBrightnessMode)

Optional. Controls the screen brightness mode.

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 either BRIGHTNESS_AUTOMATIC or BRIGHTNESS_FIXED to set this. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9. Supported on work profiles on company-owned devices on Android 15 and above.

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

enum (ScreenTimeoutMode)

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

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 than maximumTimeToLock, otherwise the screen timeout is set to maximumTimeToLock and a NonComplianceDetail with INVALID_VALUE reason and SCREEN_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 be SCREEN_TIMEOUT_ENFORCED. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_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".