Since: API level 6
public class

EnterpriseKnoxManager

extends Object
java.lang.Object
   ↳ com.samsung.android.knox.EnterpriseKnoxManager

Class Overview

Public interface for managing premium policies enforced on a device. Most clients of this class must have published a DeviceAdminReceiver that the user has currently enabled.

Since
API level 6
KNOX 1.0

Summary

Public Methods
AdvancedRestrictionPolicy getAdvancedRestrictionPolicy()
Get the object to access the Advanced Restriction policy.
AuditLog getAuditLogPolicy()
Get the object to access the Enterprise AuditLog policy

CertificatePolicy getCertificatePolicy()
Get the object to access the Certificate Policy.
ClientCertificateManager getClientCertificateManagerPolicy()
Get the object to access Client Certificate Manager policy

EnhancedAttestationPolicy getEnhancedAttestationPolicy()
Get the object to access the Enhanced Attestation Policy.
EnterpriseBillingPolicy getEnterpriseBillingPolicy()
Get the object to access the Enterprise Billing Policy
EnterpriseCertEnrollPolicy getEnterpriseCertEnrollPolicy(String cepProtocol)
Get the object to access the Enterprise Certificate Enrollment Policy.
GenericVpnPolicy getGenericVpnPolicy(String vendorPkgName, int userId)
Get the object to access the GenericVpnPolicy.
static EnterpriseKnoxManager getInstance(Context context)
API to create an instance of EnterpriseKnoxManager Object.
synchronized KnoxContainerManager getKnoxContainerManager(int containerId)
Get the object to access the KnoxContainerManager for the given containerId.
NetworkAnalytics getNetworkAnalytics()
Get the object to access the network analytics platform.
static EnterpriseKnoxManager getParentInstance(Context context)
API to create an parent instance of EnterpriseKnoxManager Object.
TimaKeystore getTimaKeystorePolicy()
Get the object to access TIMA Keystore policy

UniversalCredentialManager getUCMManager()
Get the object to access the Universal Credential Manager Policy.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public AdvancedRestrictionPolicy getAdvancedRestrictionPolicy ()

Since: API level 11

Get the object to access the Advanced Restriction policy.

Returns
  • Advanced Restriction policy object if success, else null.
Usage
Administrator can get the object to access the Advanced Restriction policy.

Since
API level 11
KNOX 2.0

public AuditLog getAuditLogPolicy ()

Since: API level 6

Get the object to access the Enterprise AuditLog policy

Returns
  • Enterprise AuditLog policy object, else return null.
Usage
Administrator can get the object to access the Enterprise AuditLog policy.

Since
API level 6
KNOX 1.0

public CertificatePolicy getCertificatePolicy ()

Since: API level 11

Get the object to access the Certificate Policy.

Returns
Usage
Admin can get the object to access the CertificatePolicy object.

Since
API level 11
KNOX 2.0

public ClientCertificateManager getClientCertificateManagerPolicy ()

Since: API level 11

Get the object to access Client Certificate Manager policy

Returns
  • Client Certificate Manager policy object
Usage
Administrator can get the object to access the Client Certificate Manager policy.

Since
API level 11
KNOX 2.0

public EnhancedAttestationPolicy getEnhancedAttestationPolicy ()

Since: API level 29

Get the object to access the Enhanced Attestation Policy.

Returns
Usage

Used to get the object to access the Enhanced Attestation Policy.

Since
API level 29
KNOX 3.4

public EnterpriseBillingPolicy getEnterpriseBillingPolicy ()

Since: API level 13

Get the object to access the Enterprise Billing Policy

Returns
  • EnterpriseBillingPolicy object
Since
API level 13
KNOX 2.2

public EnterpriseCertEnrollPolicy getEnterpriseCertEnrollPolicy (String cepProtocol)

Since: API level 12

Get the object to access the Enterprise Certificate Enrollment Policy.

Parameters
cepProtocol The Certificate enrollment protocol for which the policy object is retrieved e.g. CERT_PROFILE_TYPE_SCEP for SCEP.
Returns
Usage

Admin can get the object to access the EnterpriseCertEnrollPolicy.

Since
API level 12
KNOX 2.1

public GenericVpnPolicy getGenericVpnPolicy (String vendorPkgName, int userId)

Since: API level 11

Get the object to access the GenericVpnPolicy.
Additional info:
Administrator can instantiate the GenericVpnPolicy class using the below API.

NOTE: From API level 30 on, this method can receive com.android.settings as vendorPkgName parameter to retrieve and delete VPN profiles created by the end-user. APIs that are not supported for this vendor will return OPERATION_NOT_ALLOWED_FOR_VENDOR.

Parameters
vendorPkgName Vpn Client or Android Settings (see the note above) package name.
userId The Id of the user in which the Vpn Client is installed
0, If the Vpn Client is installed in Main User (Non-Container).
Returns
  • The GenericVpnPolicy object if success, else null.
Throws
SecurityException If caller does not have required permissions.
Usage

Administrator can get the object to access the GenericVpnPolicy.

 EnterpriseKnoxManager ekm = EnterpriseKnoxManager.getInstance(context);
 GenericVpnPolicy gvp = ekm.getGenericVpnPolicy("com.vpn.solution", userId):
        
Since
API level 11
KNOX 2.0

public static EnterpriseKnoxManager getInstance (Context context)

Since: API level 6

API to create an instance of EnterpriseKnoxManager Object.

Parameters
context The Android context object of the calling application.
Returns
  • Returns the EnterpriseKnoxManager object, else returns null
Usage
Used to get access to EnterpriseKnoxManager object.

 EnterpriseKnoxManager ekm = EnterpriseKnoxManager.getInstance(context);
        
Since
API level 6
KNOX 1.0

public synchronized KnoxContainerManager getKnoxContainerManager (int containerId)

Since: API level 11

Get the object to access the KnoxContainerManager for the given containerId.

Parameters
containerId The ID of the container to be managed.
Returns
  • KnoxContainerManager object if container exists, else return null.
Usage
Administrator can get the object to access the Knox Container Management policies. This object can be used to perform actions on the container with the specified Id.

Since
API level 11
KNOX 2.0

public NetworkAnalytics getNetworkAnalytics ()

Since: API level 22

Get the object to access the network analytics platform.

Returns
  • The NetworkAnalytics object if success, else null.
Throws
SecurityException If caller does not have required permissions.
Usage

Administrator can get the object to access the Network Analytics platform APIs.

Since
API level 22
KNOX 2.8

public static EnterpriseKnoxManager getParentInstance (Context context)

Since: API level 33

API to create an parent instance of EnterpriseKnoxManager Object.

Parameters
context The Android context object of the calling application.
Returns
  • Returns the parent EnterpriseKnoxManager object, else returns null
Usage
Used to get access to parent EnterpriseKnoxManager object.

 EnterpriseKnoxManager ekm = EnterpriseKnoxManager.getInstance(context);
        
Since
API level 33
KNOX 3.7

public TimaKeystore getTimaKeystorePolicy ()

Since: API level 11

Get the object to access TIMA Keystore policy

Returns
  • TIMA Keystore policy object
Usage
Administrator can get the object to access the TIMA Keystore policy.

Since
API level 11
KNOX 2.0

public UniversalCredentialManager getUCMManager ()

Since: API level 26

Get the object to access the Universal Credential Manager Policy.

Returns
Usage

Administrator can get the object to access the UniversalCredentialManager.

Since
API level 26
KNOX 3.2