List

Lists policies for a given enterprise

3 variables
161 variables

Lists policies for a given enterprise

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • Manage Android devices and apps for your customers

Input

This building block consumes 3 input parameters

  = Parameter name
  = Format

parent STRING Required

The name of the enterprise in the form enterprises/{enterpriseId}

pageToken STRING

A token identifying a page of results returned by the server

pageSize INTEGER

The requested page size. The actual page size may be fixed to a min or max value

Output

This building block provides 161 output parameters

  = Parameter name
  = Format

policies[] OBJECT

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

policies[].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 the applications setting. The apps appear on a single page in alphabetical order. It is recommended to also use status_bar_disabled to block access to device settings

policies[].longSupportMessage OBJECT

Provides a user-facing message with locale info. The maximum message length is 4096 characters

policies[].longSupportMessage.defaultMessage STRING

The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided

policies[].longSupportMessage.localizedMessages OBJECT

A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr

policies[].longSupportMessage.localizedMessages.customKey.value STRING

A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr

policies[].keyguardDisabledFeatures[] ENUMERATION

policies[].vpnConfigDisabled BOOLEAN

Whether configuring VPN is disabled

policies[].cameraDisabled BOOLEAN

Whether all cameras on the device are disabled

policies[].factoryResetDisabled BOOLEAN

Whether factory resetting from settings is disabled

policies[].wifiConfigDisabled BOOLEAN

Whether configuring Wi-Fi access points is disabled

policies[].policyEnforcementRules[] OBJECT

A rule that defines the actions to take if a device or work profile is not compliant with the policy specified in settingName

policies[].policyEnforcementRules[].wipeAction OBJECT

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

policies[].policyEnforcementRules[].settingName STRING

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

policies[].policyEnforcementRules[].blockAction OBJECT

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

policies[].addUserDisabled BOOLEAN

Whether adding new users and profiles is disabled

policies[].setUserIconDisabled BOOLEAN

Whether changing the user icon is disabled

policies[].setWallpaperDisabled BOOLEAN

Whether changing the wallpaper is disabled

policies[].shortSupportMessage OBJECT

Provides a user-facing message with locale info. The maximum message length is 4096 characters

policies[].shortSupportMessage.defaultMessage STRING

The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided

policies[].shortSupportMessage.localizedMessages OBJECT

A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr

policies[].shortSupportMessage.localizedMessages.customKey.value STRING

A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr

policies[].ensureVerifyAppsEnabled BOOLEAN

Whether app verification is force-enabled

policies[].debuggingFeaturesAllowed BOOLEAN

Whether the user is allowed to enable debugging features

policies[].openNetworkConfiguration OBJECT

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

policies[].openNetworkConfiguration.customKey.value ANY

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

policies[].cellBroadcastsConfigDisabled BOOLEAN

Whether configuring cell broadcast is disabled

policies[].shareLocationDisabled BOOLEAN

Whether location sharing is disabled

policies[].androidDevicePolicyTracks[] ENUMERATION

policies[].modifyAccountsDisabled BOOLEAN

Whether adding or removing accounts is disabled

policies[].frpAdminEmails[] STRING

policies[].locationMode ENUMERATION

The degree of location detection enabled. The user may change the value unless the user is otherwise blocked from accessing device settings

policies[].installUnknownSourcesAllowed BOOLEAN

Whether the user is allowed to enable the "Unknown Sources" setting, which allows installation of apps from unknown sources

policies[].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

policies[].persistentPreferredActivities[] OBJECT

A default activity for handling intents that match a particular intent filter

policies[].persistentPreferredActivities[].actions[] STRING

policies[].persistentPreferredActivities[].categories[] STRING

policies[].persistentPreferredActivities[].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

policies[].setupActions[] OBJECT

An action executed during setup

policies[].setupActions[].launchApp OBJECT

An action to launch an app

policies[].setupActions[].description OBJECT

Provides a user-facing message with locale info. The maximum message length is 4096 characters

policies[].setupActions[].title OBJECT

Provides a user-facing message with locale info. The maximum message length is 4096 characters

policies[].bluetoothContactSharingDisabled BOOLEAN

Whether bluetooth contact sharing is disabled

policies[].createWindowsDisabled BOOLEAN

Whether creating windows besides app windows is disabled

policies[].autoTimeRequired BOOLEAN

Whether auto time is required, which prevents the user from manually setting the date and time

policies[].removeUserDisabled BOOLEAN

Whether removing other users is disabled

policies[].complianceRules[] OBJECT

A rule declaring which mitigating actions to take when a device is not compliant with its policy. For every rule, there is always an implicit mitigating action to set policy_compliant to false for the Device resource, and display a message on the device indicating that the device is not compliant with its policy. Other mitigating actions may optionally be taken as well, depending on the field values in the rule

policies[].complianceRules[].apiLevelCondition OBJECT

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

policies[].complianceRules[].nonComplianceDetailCondition OBJECT

A compliance rule condition which is satisfied if there exists any matching NonComplianceDetail for the device. A NonComplianceDetail matches a NonComplianceDetailCondition if all the fields which are set within the NonComplianceDetailCondition match the corresponding NonComplianceDetail fields

policies[].complianceRules[].packageNamesToDisable[] STRING

policies[].complianceRules[].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

policies[].smsDisabled BOOLEAN

Whether sending and receiving SMS messages is disabled

policies[].systemUpdate OBJECT

Configuration for managing system updates

policies[].systemUpdate.endMinutes 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 start_minutes, 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

policies[].systemUpdate.type ENUMERATION

The type of system update to configure

policies[].systemUpdate.startMinutes 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

policies[].installAppsDisabled BOOLEAN

Whether user installation of apps is disabled

policies[].appAutoUpdatePolicy ENUMERATION

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

policies[].uninstallAppsDisabled BOOLEAN

Whether user uninstallation of applications is disabled

policies[].statusBarDisabled BOOLEAN

Whether the status bar is disabled. This disables notifications, quick settings, and other screen overlays that allow escape from full-screen mode

policies[].deviceOwnerLockScreenInfo OBJECT

Provides a user-facing message with locale info. The maximum message length is 4096 characters

policies[].deviceOwnerLockScreenInfo.defaultMessage STRING

The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided

policies[].deviceOwnerLockScreenInfo.localizedMessages OBJECT

A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr

policies[].deviceOwnerLockScreenInfo.localizedMessages.customKey.value STRING

A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr

policies[].credentialsConfigDisabled BOOLEAN

Whether configuring user credentials is disabled

policies[].blockApplicationsEnabled 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

policies[].accountTypesWithManagementDisabled[] STRING

policies[].safeBootDisabled BOOLEAN

Whether rebooting the device into safe boot is disabled

policies[].applications[] OBJECT

Policy for an individual app

policies[].applications[].defaultPermissionPolicy ENUMERATION

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

policies[].applications[].disabled BOOLEAN

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

policies[].applications[].delegatedScopes[] ENUMERATION

policies[].applications[].packageName STRING

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

policies[].applications[].installType ENUMERATION

The type of installation to perform

policies[].applications[].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 a NonComplianceDetail with non_compliance_reason 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

policies[].applications[].lockTaskAllowed BOOLEAN

Whether the app is allowed to lock itself in full-screen mode

policies[].applications[].managedConfiguration OBJECT

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:

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

policies[].applications[].managedConfiguration.customKey.value ANY

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:

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

policies[].applications[].managedConfigurationTemplate OBJECT

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

policies[].minimumApiLevel INTEGER

The minimum allowed Android API level

policies[].usbMassStorageEnabled BOOLEAN

Whether USB storage is enabled. Deprecated

policies[].keyguardDisabled BOOLEAN

Whether the keyguard is disabled

policies[].choosePrivateKeyRules[] OBJECT

A rule for automatically choosing a private key and certificate to authenticate the device to a server

policies[].choosePrivateKeyRules[].privateKeyAlias STRING

The alias of the private key to be used

policies[].choosePrivateKeyRules[].packageNames[] STRING

policies[].choosePrivateKeyRules[].urlPattern STRING

The URL pattern to match against the URL of the outgoing request. The pattern may contain asterisk (*) wildcards. Any URL is matched if unspecified

policies[].permissionGrants[] OBJECT

Configuration for an Android permission and its grant state

policies[].permissionGrants[].permission STRING

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

policies[].permissionGrants[].policy ENUMERATION

The policy for granting the permission

policies[].permittedInputMethods OBJECT

A list of package names

policies[].permittedInputMethods.packageNames[] STRING

policies[].screenCaptureDisabled BOOLEAN

Whether screen capture is disabled

policies[].passwordPolicies[] OBJECT

Requirements for the password used to unlock a device

policies[].passwordPolicies[].passwordMinimumNonLetter INTEGER

Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX

policies[].passwordPolicies[].passwordHistoryLength INTEGER

The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction

policies[].passwordPolicies[].maximumFailedPasswordsForWipe INTEGER

Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction

policies[].passwordPolicies[].passwordQuality ENUMERATION

The required password quality

policies[].passwordPolicies[].passwordScope ENUMERATION

The scope that the password requirement applies to

policies[].passwordPolicies[].passwordMinimumNumeric INTEGER

Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX

policies[].passwordPolicies[].passwordMinimumSymbols INTEGER

Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX

policies[].passwordPolicies[].passwordMinimumLetters INTEGER

Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX

policies[].passwordPolicies[].passwordMinimumLowerCase INTEGER

Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX

policies[].passwordPolicies[].passwordMinimumLength INTEGER

The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX

policies[].passwordPolicies[].passwordExpirationTimeout ANY

Password expiration timeout

policies[].passwordPolicies[].passwordMinimumUpperCase INTEGER

Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX

policies[].networkResetDisabled BOOLEAN

Whether resetting network settings is disabled

policies[].mobileNetworksConfigDisabled BOOLEAN

Whether configuring mobile networks is disabled

policies[].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

policies[].name STRING

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

policies[].playStoreMode ENUMERATION

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

policies[].unmuteMicrophoneDisabled BOOLEAN

Whether the microphone is muted and adjusting microphone volume is disabled

policies[].encryptionPolicy ENUMERATION

Whether encryption is enabled

policies[].recommendedGlobalProxy OBJECT

Configuration info for an HTTP proxy. For a direct proxy, set the host, port, and excluded_hosts fields. For a PAC script proxy, set the pac_uri field

policies[].recommendedGlobalProxy.pacUri STRING

The URI of the PAC script used to configure the proxy

policies[].recommendedGlobalProxy.port INTEGER

The port of the direct proxy

policies[].recommendedGlobalProxy.host STRING

The host of the direct proxy

policies[].recommendedGlobalProxy.excludedHosts[] STRING

policies[].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

policies[].usbFileTransferDisabled BOOLEAN

Whether transferring files over USB is disabled

policies[].outgoingCallsDisabled BOOLEAN

Whether outgoing calls are disabled

policies[].adjustVolumeDisabled BOOLEAN

Whether adjusting the master volume is disabled

policies[].defaultPermissionPolicy ENUMERATION

The default permission policy for runtime permission requests

policies[].stayOnPluggedModes[] ENUMERATION

policies[].bluetoothConfigDisabled BOOLEAN

Whether configuring bluetooth is disabled

policies[].outgoingBeamDisabled BOOLEAN

Whether using NFC to beam data from apps is disabled

policies[].dataRoamingDisabled BOOLEAN

Whether roaming data services are disabled

policies[].wifiConfigsLockdownEnabled BOOLEAN

DEPRECATED - Use wifi_config_disabled

policies[].bluetoothDisabled BOOLEAN

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

policies[].alwaysOnVpnPackage OBJECT

Configuration for an always-on VPN connection

policies[].alwaysOnVpnPackage.lockdownEnabled BOOLEAN

Disallows networking when the VPN is not connected

policies[].alwaysOnVpnPackage.packageName STRING

The package name of the VPN app

policies[].version INTEGER

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

policies[].mountPhysicalMediaDisabled BOOLEAN

Whether the user mounting physical external media is disabled

policies[].passwordRequirements OBJECT

Requirements for the password used to unlock a device

policies[].passwordRequirements.passwordMinimumNonLetter INTEGER

Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX

policies[].passwordRequirements.passwordHistoryLength INTEGER

The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction

policies[].passwordRequirements.maximumFailedPasswordsForWipe INTEGER

Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction

policies[].passwordRequirements.passwordQuality ENUMERATION

The required password quality

policies[].passwordRequirements.passwordScope ENUMERATION

The scope that the password requirement applies to

policies[].passwordRequirements.passwordMinimumNumeric INTEGER

Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX

policies[].passwordRequirements.passwordMinimumSymbols INTEGER

Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX

policies[].passwordRequirements.passwordMinimumLetters INTEGER

Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX

policies[].passwordRequirements.passwordMinimumLowerCase INTEGER

Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX

policies[].passwordRequirements.passwordMinimumLength INTEGER

The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX

policies[].passwordRequirements.passwordExpirationTimeout ANY

Password expiration timeout

policies[].passwordRequirements.passwordMinimumUpperCase INTEGER

Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX

policies[].tetheringConfigDisabled BOOLEAN

Whether configuring tethering and portable hotspots is disabled

policies[].statusReportingSettings OBJECT

Settings controlling the behavior of status reports

policies[].statusReportingSettings.softwareInfoEnabled BOOLEAN

Whether software info reporting is enabled

policies[].statusReportingSettings.applicationReportsEnabled BOOLEAN

Whether app reports are enabled

policies[].statusReportingSettings.hardwareStatusEnabled BOOLEAN

Whether hardware status reporting is enabled

policies[].statusReportingSettings.memoryInfoEnabled BOOLEAN

Whether memory reporting is enabled

policies[].statusReportingSettings.displayInfoEnabled BOOLEAN

Whether displays reporting is enabled

policies[].statusReportingSettings.powerManagementEventsEnabled BOOLEAN

Whether power management event reporting is enabled

policies[].statusReportingSettings.deviceSettingsEnabled BOOLEAN

Whether device settings reporting is enabled

policies[].statusReportingSettings.networkInfoEnabled BOOLEAN

Whether network info reporting is enabled

policies[].statusReportingSettings.applicationReportingSettings OBJECT

Settings controlling the behavior of application reports

policies[].statusReportingSettings.applicationReportingSettings.includeRemovedApps BOOLEAN

Whether removed apps are included in application reports

policies[].maximumTimeToLock INTEGER

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

policies[].funDisabled BOOLEAN

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

nextPageToken STRING

If there are more results, a token to retrieve next page of results