java.lang.Object | |
↳ | com.samsung.android.knox.container.KnoxConfigurationType |
Known Direct Subclasses |
Deprecated
in API level 36
NOTE: This API is not available since Android 13.
Interface for managing a container configuration type.
In Knox 2.0 a new concept has been introduced for the MDMs to create a container with initial policy configurations. A policy configuration can be
created , by using
A simple way to find all these pre-provisioned object is by accessing
A new set of configurations can be created by cloning an existing configuration. For details please refer to Known pre-provisioned configuration types are
Note for knox-b2b-com:
Create Classic UI container
try {
KnoxConfigurationType predefinedConfiguration = KnoxContainerManager.getConfigurationTypeByName("knox-b2b");
KnoxConfigurationType newConfig = predefinedConfiguration.clone("custom-configuration"); //Clones and assigns a new name
newConfig.setContainerLayout( |
API level 11 |
KNOX 2.0 |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
android.os.Parcelable
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
API to enable/disable the layout switching.
| |||||||||||
API to return a new KnoxConfigurationType object by cloning it from another existing KnoxConfigurationType object.
| |||||||||||
API to enable or disable multi-factor authentication.
| |||||||||||
API to check whether user is allowed to change data sync policy through UI options.
| |||||||||||
API to get the list of apps that will be installed inside container.
| |||||||||||
API to get Biometric Autentication value.
| |||||||||||
API to get the default container layout type.
| |||||||||||
API to get the custom home screen wallpaper.
| |||||||||||
API to get the custom lock screen wallpaper.
| |||||||||||
API to get customized container badge icon from
configuration type.
| |||||||||||
API to get custom container icon from
configuration type.
| |||||||||||
API to get customised container name from
configuration type.
| |||||||||||
API to get customised name icon from
configuration type.
| |||||||||||
API to get the data sync property value, for the given application.
| |||||||||||
Deprecated
in API level 33
NOTE: This API is not available since Android 11. | |||||||||||
API to get a list of forbidden strings for password.
| |||||||||||
API to get the features that has been disabled container keyguard.
| |||||||||||
API to get the list of applications from allow user change data sync policy based on
property and its value.
| |||||||||||
API to get the list of applications from data sync policy based on property and its value.
| |||||||||||
API to get the maximum character occurances in password.
| |||||||||||
API to get the maximum character sequence length.
| |||||||||||
API to get the maximum failed attempts before the device wipes.
| |||||||||||
API to get the maximum numeric sequence allowed
from the configuration.
| |||||||||||
API to get the password lock delay.
| |||||||||||
API to get the name of a type object.
| |||||||||||
API to get the minimum length required for a password.
| |||||||||||
API to get the minimum alphabetical characters required for setting a password
from the configuration.
| |||||||||||
API to get the minimum lower case letters required for setting a password
from the configuration.
| |||||||||||
API to get the minimum non alphabetical characters required for setting a password
from the configuration.
| |||||||||||
API to get the minimum numerics required for setting a password
from the configuration.
| |||||||||||
API to get the minimum number of symbols required for setting a password
from the configuration.
| |||||||||||
API to get the minimum upper case letters required for setting a password
from the configuration.
| |||||||||||
API to get the password quality required for setting a password
from the type object.
| |||||||||||
API to get the required password pattern restriction.
| |||||||||||
Deprecated
in API level 35
| |||||||||||
API to get whether custom container is enabled/disabled from
configuration type.
| |||||||||||
API to check whether the layout switching is enabled/disabled.
| |||||||||||
API to check whether multi-factor authentication is enabled.
| |||||||||||
API to allow/disallow user changing the data sync policy through UI options.
| |||||||||||
API to set the list of apps that will be installed inside container.
| |||||||||||
Deprecated
in API level 35
| |||||||||||
API to set the default container layout type.
| |||||||||||
API to set the custom home screen wallpaper path.
| |||||||||||
API to set the custom lock screen wallpaper path.
| |||||||||||
API to set custom container badge icon to
configuration type.
| |||||||||||
API to set custom container is enabled/disabled to
configuration type.
| |||||||||||
API to set custom container icon to
configuration type.
| |||||||||||
API to set customised container name to
configuration type.
| |||||||||||
API to set customised name icon to
configuration type.
| |||||||||||
API to set the data sync policies for remote content providers inside container.
| |||||||||||
Deprecated
in API level 33
NOTE: This API is not available since Android 11. | |||||||||||
API to set the list of forbidden strings for password.
| |||||||||||
API to set the features need to be disabled for container keyguard.
| |||||||||||
API to set the maximum character occurances in password.
| |||||||||||
API to set the maximum character sequence length.
| |||||||||||
API to set the maximum failed attempts before the device wipes.
| |||||||||||
API to set the maximum numeric sequence allowed.
| |||||||||||
API to set the password lock delay.
| |||||||||||
API to set the name of a type object.
| |||||||||||
API to set the minimum length required for a password.
| |||||||||||
API to set the minimum alphabetical characters required for setting a password
in the configuration.
| |||||||||||
API to set the minimum lower case letters required for setting a password
in the configuration.
| |||||||||||
API to set the minimum non alphabetical characters required for setting a password
from the configuration.
| |||||||||||
API to set the minimum numerics required for setting a password
in the configuration.
| |||||||||||
API to set the minimum number of symbols required for setting a password
in the configuration.
| |||||||||||
API to set the minimum upper case letters required for setting a password
in the configuration.
| |||||||||||
API to set the password quality required for setting a password
in the type object.
| |||||||||||
API to set the required password pattern restriction.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
android.os.Parcelable
|
API to enable/disable the layout switching.
API to enable/disable the layout switching. This API will only work when object is clone of "knox-b2b" tag. |
API level 17 |
KNOX 2.5 |
API to return a new KnoxConfigurationType object by cloning it from another existing KnoxConfigurationType object.
try { KnoxConfigurationType predefinedConfiguration = KnoxContainerManager.getConfigurationTypeByName("knox"); KnoxConfigurationType newConfig = predefinedConfiguration.clone("custom-configuration"); //Clones and assigns a new name ArrayList |
API level 11 |
KNOX 2.0 |
API to enable or disable multi-factor authentication.
API level 13 |
KNOX 2.2 |
API to check whether user is allowed to change data sync policy through UI options.
API level 11 |
KNOX 2.0 |
API to get the list of apps that will be installed inside container.
API level 11 |
KNOX 2.0 |
API to get Biometric Autentication value.
API to get the default container layout type.
API level 17 |
KNOX 2.5 |
API to get the custom home screen wallpaper.
API level 11 |
KNOX 2.0 |
API to get the custom lock screen wallpaper.
API level 20 |
KNOX 2.7 |
API to get customized container badge icon from configuration type.
API level 20 |
KNOX 2.7 |
API to get custom container icon from configuration type.
API level 20 |
KNOX 2.7 |
API to get customised container name from configuration type.
API level 20 |
KNOX 2.7 |
API to get customised name icon from configuration type.
API level 20 |
KNOX 2.7 |
API to get the data sync property value, for the given application.
API level 11 |
KNOX 2.0 |
Deprecated
in API level 33
NOTE: This API is not available since Android 11.
API to get Enterprise Identity configuration from KnoxConfigurationType.
Note: Due to Android security limitations, the enterprise identity authentication feature will not work when
Device Owner
is enabled on the device.
Admin can use this api to get current Enterprise Identity
authentication configurations.
Note: Currently Enterprise Identity is supported only on Container. |
// When you create container successfully, containerID will be returned via intent. // Use this containerID in below API. EnterpriseKnoxManager ekm = EnterpriseKnoxManager.getInstance(context); KnoxContainerManager kcm = ekm.getKnoxContainerManager(containerID); KnoxConfigurationType predefinedConfiguration = kcm.getConfigurationTypeByName("knox"); KnoxConfigurationType newConfig = predefinedConfiguration.clone("custom-configuration"); try { AuthenticationConfig authConfig = newConfig.getEnterpriseIdentityAuthentication(); if (authConfig != null ) { //successfully retrieved authentication config } else { //unable to get authentication config } }catch (SecurityException e) { Log.e(TAG, "SecurityException: " + e); } |
API level 15 |
KNOX 2.4 |
API to get a list of forbidden strings for password.
API level 11 |
KNOX 2.0 |
API to get the features that has been disabled container keyguard.
API level 15 |
KNOX 2.4 |
API to get the list of applications from allow user change data sync policy based on property and its value.
API level 11 |
KNOX 2.0 |
API to get the list of applications from data sync policy based on property and its value.
API level 11 |
KNOX 2.0 |
API to get the maximum character occurances in password.
API level 11 |
KNOX 2.0 |
API to get the maximum character sequence length.
API level 11 |
KNOX 2.0 |
API to get the maximum failed attempts before the device wipes.
API level 11 |
KNOX 2.0 |
API to get the maximum numeric sequence allowed from the configuration.
API level 11 |
KNOX 2.0 |
API to get the password lock delay.
API level 11 |
KNOX 2.0 |
API to get the name of a type object.
API level 11 |
KNOX 2.0 |
API to get the minimum length required for a password.
API level 11 |
KNOX 2.0 |
API to get the minimum alphabetical characters required for setting a password from the configuration.
API level 11 |
KNOX 2.0 |
API to get the minimum lower case letters required for setting a password from the configuration.
API level 11 |
KNOX 2.0 |
API to get the minimum non alphabetical characters required for setting a password from the configuration.
API level 11 |
KNOX 2.0 |
API to get the minimum numerics required for setting a password from the configuration.
API level 11 |
KNOX 2.0 |
API to get the minimum number of symbols required for setting a password from the configuration.
API level 11 |
KNOX 2.0 |
API to get the minimum upper case letters required for setting a password from the configuration.
API level 11 |
KNOX 2.0 |
API to get the password quality required for setting a password from the type object.
API level 11 |
KNOX 2.0 |
API to get the required password pattern restriction.
API level 12 |
KNOX 2.1 |
Deprecated in API level 35
API to check whether the biometric authentication option is enabled or not in the configuration.
API level 14 |
KNOX 2.3 |
API to get whether custom container is enabled/disabled from configuration type.
API level 20 |
KNOX 2.7 |
API to check whether the layout switching is enabled/disabled.
API level 17 |
KNOX 2.5 |
API to check whether multi-factor authentication is enabled.
API level 13 |
KNOX 2.2 |
API to allow/disallow user changing the data sync policy through UI options.
API level 11 |
KNOX 2.0 |
API to set the list of apps that will be installed inside container.
API level 11 |
KNOX 2.0 |
Deprecated in API level 35
API to set the biometric authentication option in the configuration required to enable or disable it on the list of lockscreen password options.
API level 14 |
KNOX 2.3 |
API to set the default container layout type.
API to set the default container layout type.
This API will only work when object is clone of "knox-b2b" tag.
It accepts CONTAINER_LAYOUT_TYPE_FOLDER and CONTAINER_LAYOUT_TYPE_CLASSIC |
API level 17 |
KNOX 2.5 |
API to set the custom home screen wallpaper path.
API level 11 |
KNOX 2.0
NOTE: It is recommended administrator to use image with resolution which is in proportion to the device screen dimensions. |
API to set the custom lock screen wallpaper path.
API level 20 |
KNOX 2.7 |
API to set custom container badge icon to configuration type.
API level 20 |
KNOX 2.7 |
API to set custom container is enabled/disabled to configuration type.
API level 20 |
KNOX 2.7 |
API to set custom container icon to configuration type.
API level 20 |
KNOX 2.7 |
API to set customised container name to configuration type.
API level 20 |
KNOX 2.7 |
API to set customised name icon to configuration type.
API level 20 |
KNOX 2.7 |
API to set the data sync policies for remote content providers inside container.
API level 11 |
KNOX 2.0 |
Deprecated
in API level 33
NOTE: This API is not available since Android 11.
API to configure and enforce Enterprise Identity authentication during container creation. Enterprise Identity authentication is another type of lock like PIN/Password/etc. It allows user to use their enterprise credential as container unlock method
Admin use this api to configure and enforce Enterprise Identity authentication for creating container. Admin can either just configure Enterprise Identity and let user to choose lock type or admin can enforce user to choose Enterprise Identity. Enterprise Identity authentication lock will enforce password quality and all password complexity rules passed part of KnoxConfigurationType. So its admin responsibility to set up proper password quality and complexity rules which matches on Enterprise Identity server(e.g Active Directory). If password complexity rules passed on KnoxConfigurtionType are not match with Enterprise Identity server rules user can't successfully set up Enterprise Identity even if the user uses valid credentials. Also it is the administrator responsibility to install authenticator package on the device before starting container creation. It is also recommended to disable uninstallation and clearing data of the authenticator package in the case where user tries to uninstall the application or clear its data. Admin also must understand the various fields on the configuration object and their significance to decide what configuration is best for the enterprise. Note: Currently Enterprise Identity is not supported for MDFPP SDP enabled container. Due to Android security limitations, the enterprise identity authentication feature will not work when Device Owner is enabled on the device. // The following steps MUST be followed for successful Enterprise Identity authentication set up //Step 1: Install authenticator package on device level String AUTHENTICATOR_PKGNAME = AuthenticationConfig.SAMSUNG_KERBEROS_AUTHENTICATOR ; String AUTHENTICATOR_PKGPATH = "/mnt/sdcard/authenticator.apk"; EnterpriseDeviceManager edm = EnterpriseDeviceManager.getInstance(context); ApplicationPolicy appPolicy = edm.getApplicationPolicy(); boolean result = appPolicy.installApplication(AUTHENTICATOR_PKGPATH, false); //make sure user should not able to uninstall this authenticator apk appPolicy.setApplicationUninstallationDisabled (AUTHENTICATOR_PKGNAME); //make sure user should not able to clear data of this authenticator apk List |
API level 15 |
KNOX 2.4 |
API to set the list of forbidden strings for password.
API level 11 |
KNOX 2.0 |
API to set the features need to be disabled for container keyguard.
The calling device admin must have requested USES_POLICY_DISABLE_KEYGUARD_FEATURES
to be able to call this method; if it has not, a security exception will be thrown.
which | KEYGUARD_DISABLE_FEATURES_NONE (default), KEYGUARD_DISABLE_TRUST_AGENTS |
---|
API level 15 |
KNOX 2.4 |
API to set the maximum character occurances in password.
API level 11 |
KNOX 2.0 |
API to set the maximum character sequence length.
API level 11 |
KNOX 2.0 |
API to set the maximum failed attempts before the device wipes.
API level 11 |
KNOX 2.0 |
API to set the maximum numeric sequence allowed.
API level 11 |
KNOX 2.0 |
API to set the password lock delay.
API level 11 |
KNOX 2.0 |
API to set the name of a type object.
API level 11 |
KNOX 2.0 |
API to set the minimum length required for a password.
API level 11 |
KNOX 2.0 |
API to set the minimum alphabetical characters required for setting a password in the configuration.
API level 11 |
KNOX 2.0 |
API to set the minimum lower case letters required for setting a password in the configuration.
API level 11 |
KNOX 2.0 |
API to set the minimum non alphabetical characters required for setting a password from the configuration.
API level 11 |
KNOX 2.0 |
API to set the minimum numerics required for setting a password in the configuration.
API level 11 |
KNOX 2.0 |
API to set the minimum number of symbols required for setting a password in the configuration.
API level 11 |
KNOX 2.0 |
API to set the minimum upper case letters required for setting a password in the configuration.
API level 11 |
KNOX 2.0 |
API to set the password quality required for setting a password in the type object.
API level 11 |
KNOX 2.0 |
API to set the required password pattern restriction.
API level 12 |
KNOX 2.1 |