Knox SDK

https://docs.samsungknox.com/devref/knox-sdk/reference/
Admin
The Knox SDK provides a comprehensive set of APIs for Samsung Knox devices, enabling enterprises to...
Tokens:1,439,588
Snippets:7,168
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Activity and Wallpaper Management

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/net/vpn/serviceprovider/GenericVpnService

Methods for starting activities, managing the wallpaper, and starting instrumentation.

```APIDOC
## setTheme

### Description
Sets the theme for the context.

### Method
`setTheme`

### Parameters
#### Path Parameters
- `arg0` (int) - Required - The resource ID of the theme to apply.

### Response
#### Success Response (void)
Indicates the theme was set.
```

```APIDOC
## setWallpaper

### Description
Sets the wallpaper to the given bitmap.

### Method
`setWallpaper`

### Parameters
#### Path Parameters
- `arg0` (Bitmap) - Required - The bitmap to set as wallpaper.

### Response
#### Success Response (void)
Indicates the wallpaper was set.
```

```APIDOC
## setWallpaper

### Description
Sets the wallpaper to the given input stream.

### Method
`setWallpaper`

### Parameters
#### Path Parameters
- `arg0` (InputStream) - Required - The input stream of the wallpaper.

### Response
#### Success Response (void)
Indicates the wallpaper was set.
```

```APIDOC
## startActivities

### Description
Starts activities in a new task.

### Method
`startActivities`

### Parameters
#### Path Parameters
- `arg0` (Intent[]) - Required - An array of Intents to start.
- `arg1` (Bundle) - Optional - Options for launching the activities.

### Response
#### Success Response (void)
Indicates the activities were started.
```

```APIDOC
## startActivity

### Description
Starts an activity.

### Method
`startActivity`

### Parameters
#### Path Parameters
- `arg0` (Intent) - Required - The Intent specifying the activity to start.
- `arg1` (Bundle) - Optional - Options for launching the activity.

### Response
#### Success Response (void)
Indicates the activity was started.
```

```APIDOC
## startInstrumentation

### Description
Starts an instrumentation.

### Method
`startInstrumentation`

### Parameters
#### Path Parameters
- `arg0` (ComponentName) - Required - The ComponentName of the instrumentation.
- `arg1` (String) - Required - The package name of the process to run in.
- `arg2` (Bundle) - Optional - Arguments to pass to the instrumentation.

### Response
#### Success Response (boolean)
True if the instrumentation was started successfully, false otherwise.
```

```APIDOC
## startIntentSender

### Description
Starts an IntentSender.

### Method
`startIntentSender`

### Parameters
#### Path Parameters
- `arg0` (IntentSender) - Required - The IntentSender to start.
- `arg1` (Intent) - Optional - The fillInIntent.
- `arg2` (int) - Required - Flags for the IntentSender.
- `arg3` (int) - Required - Flags for the Intent.
- `arg4` (int) - Required - Flags for the fillInIntent.
- `arg5` (Bundle) - Optional - Additional options.

### Response
#### Success Response (void)
Indicates the IntentSender was started.
```

--------------------------------

### Start Activities and Services in Android

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/ucm/plugin/agent/UcmAgentService

Provides methods for launching new activities, starting foreground or background services, and starting instrumentation. Includes options for passing additional data via bundles.

```java
void setWallpaper(Bitmap arg0)
void setWallpaper(InputStream arg0)
void startActivities(Intent[] arg0, Bundle arg1)
void startActivities(Intent[] arg0)
void startActivity(Intent arg0)
void startActivity(Intent arg0, Bundle arg1)
ComponentName startForegroundService(Intent arg0)
boolean startInstrumentation(ComponentName arg0, String arg1, Bundle arg2)
void startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4)
void startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4, Bundle arg5)
ComponentName startService(Intent arg0)
boolean stopService(Intent arg0)
```

--------------------------------

### Service Binding and Starting in Android Context

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/net/vpn/serviceprovider/GenericVpnService

Methods for interacting with Android services, including binding, starting foreground services, starting regular services, and stopping services. Supports various binding options and executor services.

```java
ComponentName startForegroundService(Intent arg0)
ComponentName startService(Intent arg0)
boolean startInstrumentation(ComponentName arg0, String arg1, Bundle arg2)
boolean stopService(Intent arg0)
void unbindService(ServiceConnection arg0)
void updateServiceGroup(ServiceConnection arg0, int arg1, int arg2)
boolean bindIsolatedService(Intent arg0, int arg1, String arg2, Executor arg3, ServiceConnection arg4)
boolean bindService(Intent arg0, int arg1, Executor arg2, ServiceConnection arg3)
abstract boolean bindService(Intent arg0, ServiceConnection arg1, int arg2)
boolean bindServiceAsUser(Intent arg0, ServiceConnection arg1, int arg2, UserHandle arg3)
```

--------------------------------

### Get Packages from Install White List

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/container/ContainerConfigurationPolicy

Retrieves the list of package names from the white list that are permitted to install other applications within a container. This API is available from API level 11 but is deprecated starting from API level 30 and is not available since Android 13.

```APIDOC
## GET /packages/install-whitelist

### Description
Retrieves a list of package names that are allowed to install other applications within the Knox container. This list is maintained by the container administrator.

### Method
GET

### Endpoint
/packages/install-whitelist

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **packages** (List<String>) - A list of package names from the install whitelist.

#### Response Example
```json
{
  "packages": [
    "com.example.app1",
    "com.example.app2"
  ]
}
```

### Error Handling
- **SecurityException**: Thrown if the caller lacks the required permissions or is not the administrator who created the container.
- **IllegalArgumentException**: Thrown if the specified container does not exist or is currently being created or removed.

### Permissions
Requires `com.samsung.android.knox.permission.KNOX_APP_MGMT` permission (signature protection level).

### Since
API level 11

### Deprecated
Deprecated in API level 30. Not available since Android 13.
```

--------------------------------

### KeyGenParameterSpec Initialization Example

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/ucm/plugin/keystore/KeyGenParameterSpec

Example of how the initialize method is used with KeyGenParameterSpec.

```APIDOC
## Initialize Method Example

### Description
This code snippet demonstrates the `initialize` method within the context of KeyGenParameterSpec, showing how key details are extracted from the provided parameters.

```java
public void initialize(AlgorithmParameterSpec params, SecureRandom random) throws InvalidAlgorithmParameterException {
  if ((params instanceof KeyGenParameterSpec) == false) {
    Log.e(TAG, "AlgorithmParameterSpec is not UCM KeyGenParameterSpec");
    throw new InvalidAlgorithmParameterException("AlgorithmParameterSpec is not UCM KeyGenParameterSpec");
  }

  KeyGenParameterSpec spec = (KeyGenParameterSpec) params;
  int keySize = spec.getKeySize();
  boolean isManaged = spec.isManaged();
  String alias = spec.getKeystoreAlias();
  int sourceUid = spec.getSourceUid();
  Bundle options = spec.getOptions();
  String algorithm = spec.getAlgorithm();
  int ownerUid = spec.getOwnerUid();
  int resourceId = spec.getResourceId();
}
```

### Throws
- `InvalidAlgorithmParameterException`: If the provided `params` is not an instance of `KeyGenParameterSpec`.
```

--------------------------------

### Get Force Auto Start Up State

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/custom/SystemManager

Retrieves the Force Auto Start Up value. The default value is off.

```APIDOC
## GET getForceAutoStartUpState

### Description
Retrieves the Force Auto Start Up value. The default value is off.

### Method
GET

### Endpoint
/automode/startup/state

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "None"
}
```

### Response
#### Success Response (200)
- **autoStartupState** (int) - `ON` if Auto start up is turned on, `OFF` if Auto start up is turned off.

#### Response Example
```json
{
  "autoStartupState": 1
}
```
```

--------------------------------

### Get Force Auto Start Up State

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/custom/SystemManager

Retrieves the current value of the Force Auto Start Up setting. This setting controls whether the device automatically starts up under certain conditions.

```Java
int getForceAutoStartUpState()
```

--------------------------------

### Activity Management (Java/Kotlin)

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/net/vpn/serviceprovider/GenericVpnService

Methods for launching activities, either individually or in sequence. This includes starting activities with or without additional parameters.

```java
abstract void startActivities(Intent[] arg0, Bundle arg1)
abstract void startActivities(Intent[] arg0)
abstract void startActivity(Intent arg0)
abstract void startActivity(Intent arg0, Bundle arg1)
```

--------------------------------

### Knox SDK Get Packages from Install Whitelist

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/container/ContainerConfigurationPolicy

Retrieves the list of packages from the install whitelist. This method is deprecated and not available since Android 13.

```java
List<String> getPackagesFromInstallWhiteList();
```

--------------------------------

### NtpInfo Constructor

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/datetime/NtpInfo

Initializes a new instance of the NtpInfo class with default system values.

```APIDOC
## Public Constructors

#### `public NtpInfo(Context context)`

**Description:** Default constructor of this class. It will initialize the parameters with system's default values.

**Since:** API level 17

**Parameters:**
- **context** (Context) - Context of calling application.

**Returns:** A new instance of `NtpInfo`.
```

--------------------------------

### Retrieving App Installation List

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/container/LightweightConfigurationType

API to get the list of apps that will be installed inside a Knox container. This provides visibility into the applications pre-configured within the container.

```java
List<String> getAppInstallationList()
```

--------------------------------

### FirewallRule Constructors

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/net/firewall/FirewallRule

Provides information on creating FirewallRule instances with different configurations.

```APIDOC
## FirewallRule Constructor

### Description
Creates a FirewallRule instance. This constructor is used to create an instance of FirewallRule. After the creation the default values for each parameter are:
  * IP Address: `"*"` (All Addresses)
  * Port Number: `"*"` (All Ports)
  * Port Location: `ALL`
  * App Identity: AppIdentity object containing `"*"` as package name and `null` as signature.
  * Network Interface:`ALL_NETWORKS`
  * Direction: `ALL`
  * Protocol: `ALL`
  * Target IP Address: `null`
  * Target Port Number: `null`

**Note:** **Target IP Address** and **Target Port Number** are only valid for `REDIRECT` type and is a mandatory field that should be set for this type of rule.

### Parameters
- **ruleType** (FirewallRule.RuleType) - Type of the rule.
- **addressType** (Firewall.AddressType) - AddressType of the rule.

### Since
API level 17
```

--------------------------------

### Get List of Apps for Container Installation

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/container/KnoxConfigurationType

API to retrieve a list of applications that are set to be installed inside a Knox container. Requires Knox SDK version 2.0 or higher.

```java
public List<String> getAppInstallationList()
```

--------------------------------

### WifiAdminProfile Constructors

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/net/wifi/WifiAdminProfile

Constructors for initializing WifiAdminProfile with different keystore engines and storage names.

```APIDOC
## POST /websites/samsungknox_devref_knox-sdk_reference/WifiAdminProfile/constructors

### Description
Allows creation of WifiAdminProfile instances with specific configurations for keystore engines and credential storage.

### Method
POST

### Endpoint
/websites/samsungknox_devref_knox-sdk_reference/WifiAdminProfile/constructors

### Parameters
#### Request Body
- **constructor_type** (string) - Required - Specifies the constructor to use ('engineId', 'storageName', 'default').
- **engineId** (int) - Optional - The keystore engine ID (e.g., ENGINE_ANDROID_KEYSTORE, ENGINE_SECPKCS11). Required if constructor_type is 'engineId'.
- **storageName** (string) - Optional - The credential storage name. Required if constructor_type is 'storageName'.

### Request Example
```json
{
  "constructor_type": "engineId",
  "engineId": 101 // Example for ENGINE_SECPKCS11
}
```
```json
{
  "constructor_type": "storageName",
  "storageName": "myCredentialStorage"
}
```
```json
{
  "constructor_type": "default"
}
```

### Response
#### Success Response (201)
- **message** (string) - Confirmation of successful profile creation.
- **profile_details** (object) - Details of the created profile (engineId, storageName).

#### Response Example
```json
{
  "message": "WifiAdminProfile created successfully.",
  "profile_details": {
    "engineId": 101,
    "storageName": null
  }
}
```
```

--------------------------------

### Container Configuration Example

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/container/LightweightConfigurationType

Example demonstrating how to create a custom lightweight container configuration, add an application to its installation list, and add the configuration using the Knox SDK.

```APIDOC
## Usage Example

### Description
This code snippet demonstrates the process of creating a custom lightweight container configuration, modifying its application list, and then adding it to the Knox container manager.

### Method
N/A (This is a usage example, not a direct API call)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```java
try {
    LightweightConfigurationType predefinedConfiguration = KnoxContainerManager.getConfigurationTypeByName("knox-b2b-lwc");
    LightweightConfigurationType newConfig = predefinedConfiguration.clone("custom-configuration"); //Clones and assigns a new name
    ArrayList appList = newConfig.getAppInstallationList();
    appList.add("com.custom.app");
    newConfig.setAppInstallationList(appList);
    KnoxContainerManager.addConfigurationType(newConfig);
} catch (RemoteException e) {
    Log.e(TAG, "UnsupportedOperationException: " + e);
}
```

### Response
N/A (This is a code example)
```

--------------------------------

### Start Attestation Process with Knox SDK

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/integrity/AttestationPolicy

Demonstrates how to initiate the attestation process using the AttestationPolicy class in the Knox SDK. This includes handling potential SecurityExceptions. Requires the 'com.samsung.android.knox.permission.KNOX_REMOTE_ATTESTATION' permission.

```Java
AttestationPolicy attestation = new AttestationPolicy(context);

try
{
 	 String nonce;
 	 attestation.startAttestation(nonce);
}
catch (SecurityException e)
{
 	 Log.w(TAG, "SecurityException: " + e);
}
```

--------------------------------

### Get Start Offset

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/ex/knoxAI/KfaOptions

Retrieves the start offset. This method is available since API level 34 and deprecated in API level 37, noting its unavailability since Android 15.

```java
public long getStartOffSet ()
```

--------------------------------

### Get Packages from Install Whitelist

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/container/ContainerConfigurationPolicy

Retrieves a list of package names from the install whitelist, allowing specified applications to install other applications within a Knox container. This API is restricted to administrators who created the container and requires specific permissions. It is deprecated and not available since Android 13.

```java
EnterpriseKnoxManager ekm = EnterpriseKnoxManager.getInstance(context);
try {
    // When you create container successfully, _containerID_ will be returned via intent.
    // Use this _containerID_ in below API.
    KnoxContainerManager kcm = ekm.getKnoxContainerManager(containerID);
    ContainerConfigurationPolicy ccp = kcm.getContainerConfigurationPolicy();
    ArrayList<String> result = (ArrayList<String>) ccp.getPackagesFromInstallWhiteList();
} catch (SecurityException e) {
    Log.w(TAG, "SecurityException: " + e);
}

```

--------------------------------

### POST /createVpnProfile

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/net/vpn/GenericVpnPolicy

Creates a new VPN connection profile. This is the initial step in establishing a VPN connection.

```APIDOC
## POST /createVpnProfile

### Description
Creates a new VPN connection profile. This API is the first step for creating a VPN connection. For JSON file creation, follow the instructions in the Developer Guide.

### Method
POST

### Endpoint
N/A (Method call: `createVpnProfile`)

### Parameters
#### Request Body
- **profileInfo** (String) - Required - A JSON object string containing the profile information.

### Request Example
```java
EnterpriseKnoxManager ekm = EnterpriseKnoxManager.getInstance(context);
GenericVpnPolicy gm = ekm.getGenericVpnPolicy("com.vpn.vendor.packageName", userId);
int success = gm.createVpnProfile("profileInfo");
```

### Response
#### Success Response (int)
- **return_value** (int) - 0: VPN profile added successfully. 1: VPN profile not added successfully. -1: Error occurred.

#### Response Example
```json
{
  "return_value": 0
}
```

### Throws
- **SecurityException**: If the caller does not have the required permissions.

### Permission
Requires `com.samsung.android.knox.permission.KNOX_VPN_GENERIC` permission.

### Since
API level 9, KNOX 1.1.0
```

--------------------------------

### Initiate User Certificate Enrollment (Java)

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/keystore/EnterpriseCertEnrollPolicy

Enrolls a user certificate using the Knox SDK. It retrieves the EnterpriseKnoxManager instance, configures the SCEP protocol, and calls the `enrollUserCertificate` method with the enrollment profile and a list of allowed packages. It includes error handling for SecurityException.

```java
EnterpriseKnoxManager ekm = EnterpriseKnoxManager.getInstance(context);
try {
  List allowedPackages = new ArrayList();
  allowedPackages.add("com.android.email");
  String cepProtocol = CEPConstants.CERT_PROFILE_TYPE_SCEP //for SCEP
  String refNum = ekm.getEnterpriseCertEnrollPolicy(Context, cepProtocol).enrollUserCertificate(enrollmentProfile,allowedPackages, hashCACert);
} catch (SecurityException e) {
  Log.w(TAG, "Exception" + e);
}
```

--------------------------------

### getRecentLongPressActivity

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/custom/SystemManager

This method gets the package that will be started when the Recent hardware button is long-pressed. It returns the package name string or null.

```APIDOC
## GET /recentLongPressActivity

### Description
Retrieves the package name associated with the long-press action of the Recent hardware button.

### Method
GET

### Endpoint
/recentLongPressActivity

### Parameters
#### Query Parameters
- None

#### Request Body
- None

### Request Example
```
// No request body for GET requests
```

### Response
#### Success Response (200)
- **packageName** (String) - The package name of the activity to be started, or null if not set.

#### Response Example
```json
{
  "packageName": "com.example.app"
}
```
```

--------------------------------

### startGeofencing

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/location/Geofencing

Starts geofence monitoring based on configured parameters.

```APIDOC
## POST /geofencing/start

### Description
API to start geofence monitoring. The device's location is monitored based on administrator-defined minimum distance and time parameters. Default parameters are used if none are set. Broadcasts are sent for geofence entry, exit, or location update issues.

### Method
POST

### Endpoint
/geofencing/start

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{} 
```

### Response
#### Success Response (200)
- **success** (boolean) - true if geofencing is successfully enabled, false otherwise.

#### Response Example
```json
{
  "success": true
}
```

### Throws
- SecurityException: If the caller does not have the required permissions.

### Permission
Requires `com.samsung.android.knox.permission.KNOX_GEOFENCING` with signature protection level.

### Usage Example (EnterpriseDeviceManager)
```java
      EnterpriseDeviceManager edm = EnterpriseDeviceManager.getInstance(context);
      Geofencing geofencingService = edm.getGeofencing();
      try {
          boolean result = geofencingService.startGeofencing();
          // Returns true on starting geofencing successfully, else returns false
      } catch (SecurityException se) {
          Log.e(TAG, "Security Exception : " + se);
      }
```

### Usage Example (KnoxContainerManager)
```java
      EnterpriseKnoxManager ekm = EnterpriseKnoxManager.getInstance(context);
      KnoxContainerManager kcm = ekm.getKnoxContainerManager(containerID);
      Geofencing geofencingService = kcm.getGeofencing();
      try {
          boolean result = geofencingService.startGeofencing();
          // Returns true on starting geofencing successfully, else returns false
      } catch (SecurityException se) {
          Log.e(TAG, "Security Exception : " + se);
      }
```
```

--------------------------------

### Get Keystore Identifier

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/keystore/CertificateInfo

Retrieves an integer identifier indicating the keystore where the certificate is installed.

```java
int keystoreId = certificateInfo.getKeystore();
```

--------------------------------

### Quick Panel Settings

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/custom/SystemManager

Methods for configuring the quick panel buttons and items.

```APIDOC
## setQuickPanelButtons

### Description
Sets the visibility of quick panel buttons.

### Method
POST

### Endpoint
/setQuickPanelButtons

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **buttons** (int) - Required - A bitmask representing the quick panel buttons to set visibility for.

### Request Example
```json
{
  "buttons": 7
}
```

### Response
#### Success Response (200)
- **result** (int) - The result of the operation.

#### Response Example
```json
{
  "result": 0
}
```
```

```APIDOC
## setQuickPanelEditMode

### Description
Turns on/off editing of the quick panel items.

### Method
POST

### Endpoint
/setQuickPanelEditMode

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **mode** (int) - Required - The mode to set: 1 to enable editing, 0 to disable.

### Request Example
```json
{
  "mode": 1
}
```

### Response
#### Success Response (200)
- **result** (int) - The result of the operation.

#### Response Example
```json
{
  "result": 0
}
```
```

```APIDOC
## setQuickPanelItems

### Description
Sets the list of items displayed in the quick panel.

### Method
POST

### Endpoint
/setQuickPanelItems

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **items** (List<Integer>) - Required - A list of integers representing the quick panel items.

### Request Example
```json
{
  "items": [1, 2, 3]
}
```

### Response
#### Success Response (200)
- **result** (int) - The result of the operation.

#### Response Example
```json
{
  "result": 0
}
```
```

--------------------------------

### GET /getDisclaimerText

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/restriction/PhoneRestrictionPolicy

Retrieves the disclaimer text for outgoing SMS and MMS messages. This API is deprecated starting from API level 35.

```APIDOC
## GET /getDisclaimerText

### Description
API to get a disclaimer text for outgoing sms and mms.

### Method
GET

### Endpoint
/getDisclaimerText

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
EnterpriseDeviceManager edm = (EnterpriseDeviceManager) getSystemService(EnterpriseDeviceManager.ENTERPRISE_POLICY_SERVICE);
PhoneRestrictionPolicy phoneRestrictionPolicy = edm.getPhoneRestrictionPolicy();

try {
    // get a new disclaimer text
    String result = phoneRestrictionPolicy.getDisclaimerText();
    if (result == null) {
        // this policy not set by any admin
    }
} catch (SecurityException e) {
    Log.w(TAG, "SecurityException: " + e);
}
```

### Response
#### Success Response (200)
- **return** (String) - Disclaimer text for outgoing SMS and MMS.

#### Response Example
```json
{
  "return": "Please review the content before sending."
}
```
```

--------------------------------

### com.samsung.android.knox.net.wifi Package Overview

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/net/wifi/package-summary

Provides classes to manage Wi-Fi settings and profiles.

```APIDOC
## Package
com.samsung.android.knox.net.wifi

### Description
Provides classes to manage Wi-Fi settings and profiles.

### Classes
* **WifiAdminProfile**: This class contains information required to set up a Wi-Fi profile on the device.
* **WifiControlInfo**: This generic class contains information on the Wi-Fi policy values for a particular administrator.
* **WifiPolicy**: This class provides APIs to configure Wi-Fi related settings and manage Wi-Fi profiles.
```

--------------------------------

### GET /api/emailaccounts

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/accounts/EmailAccountPolicy

Retrieves all email account information as a list of Account objects. This API is deprecated starting from API level 27.

```APIDOC
## GET /api/emailaccounts

### Description
This API retrieves all email account information as a list of `Account` objects. It is intended for administrators to get all existing email accounts on the device.

### Method
GET

### Endpoint
/api/emailaccounts

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Account[]** (array) - An array of `Account` objects containing all account details. Returns `null` if no email accounts exist.

#### Response Example
```json
[
  {
    "accountId": 12345,
    "emailAddress": "user@example.com",
    "accountType": "IMAP"
  }
]
```

#### Error Response (403)
- **SecurityException** - If the caller does not have the required permissions.
```

--------------------------------

### Get CA Certificate Aliases

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/ucm/configurator/UniversalCredentialManager

Retrieves a list of aliases for all available CA certificates. This API is deprecated starting from API level 37.

```APIDOC
## GET /api/ucm/certificates/aliases

### Description
Retrieves a list of aliases for all available CA certificates. This API is deprecated starting from API level 37.

### Method
GET

### Endpoint
/api/ucm/certificates/aliases

### Parameters
#### Path Parameters
None

#### Query Parameters
- **option** (Bundle) - Optional - Reserved for future use.

#### Request Body
None

### Request Example
```java
UniversalCredentialManager ucmMgr = UniversalCredentialManager.getUCMManager(mContext);
Bundle options = new Bundle();
String[] aliases = ucmMgr.getCACertificateAliases(options);
```

### Response
#### Success Response (200)
- **aliases** (String[]) - An array of strings, where each string is an alias of a CA certificate.

#### Response Example
```json
{
  "aliases": ["RootCA", "IntermediateCA", "UserCert"]
}
```

### Permissions
Requires `com.samsung.android.knox.permission.KNOX_UCM_MGMT` permission.

### API Level
API level 20 (Knox 2.7)
```

--------------------------------

### Knox SDK Instance Creation Method

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/license/EnterpriseLicenseManager

This section details the method for creating an instance of the EnterpriseLicenseManager class.

```APIDOC
## Public Methods

### getInstance(Context context)

- **Description**: Creates an instance of the EnterpriseLicenseManager class.
- **Returns**: `EnterpriseLicenseManager` - An instance of the EnterpriseLicenseManager.
- **Parameters**:
  - **context** (Context) - Required - The application context.
```

--------------------------------

### Get CA Certificate

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/ucm/configurator/UniversalCredentialManager

Retrieves a CA certificate from the credential storage using its alias. This API is deprecated starting from API level 37.

```APIDOC
## GET /api/ucm/certificates/{alias}

### Description
Retrieves a CA certificate from the credential storage using its alias. This API is deprecated starting from API level 37.

### Method
GET

### Endpoint
/api/ucm/certificates/{alias}

### Parameters
#### Path Parameters
- **alias** (String) - Required - The alias name of the CA certificate to retrieve.

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
String alias = "myCACert";
UniversalCredentialManager ucmMgr = UniversalCredentialManager.getUCMManager(mContext);
CACertificateInfo certInfo = ucmMgr.getCACertificate(alias);
```

### Response
#### Success Response (200)
- **certificateInfo** (CACertificateInfo) - An object containing the CA certificate information.

#### Response Example
```json
{
  "certificateInfo": {
    "alias": "myCACert",
    "data": "-----BEGIN CERTIFICATE-----\nMIID...\n-----END CERTIFICATE-----"
  }
}
```

### Permissions
Requires `com.samsung.android.knox.permission.KNOX_UCM_MGMT` permission.

### API Level
API level 20 (Knox 2.7)
```

--------------------------------

### Context and Configuration (Java/Kotlin)

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/net/vpn/serviceprovider/GenericVpnService

Methods for accessing core context information and managing application configuration. This includes getting the main looper, executor, and data directories.

```java
Executor getMainExecutor()
abstract Looper getMainLooper()
abstract boolean isDeviceProtectedStorage()
boolean isRestricted()
```

--------------------------------

### Get Available Credential Storages

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/ucm/configurator/UniversalCredentialManager

Retrieves a list of all available credential storage providers on the device. This API currently returns UCM plugins installed in the system user only.

```APIDOC
## GET /api/ucm/storages

### Description
Retrieves a list of all available credential storage providers on the device.

### Method
GET

### Endpoint
/api/ucm/storages

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
UniversalCredentialManager ucmMgr = UniversalCredentialManager.getUCMManager(mContext);
CredentialStorage[] storages = ucmMgr.getAvailableCredentialStorages();
```

### Response
#### Success Response (200)
- **storages** (CredentialStorage[]) - An array of CredentialStorage objects representing available storages.

#### Response Example
```json
{
  "storages": [
    {
      "name": "SampleStorage",
      "packageName": "com.example.ucm.plugin"
    }
  ]
}
```

### Permissions
Requires `com.samsung.android.knox.permission.KNOX_UCM_MGMT` permission.

### API Level
API level 20 (Knox 2.7)
```

--------------------------------

### GET /getAllPackagesInVpnProfile

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/net/vpn/GenericVpnPolicy

Returns a list of packages associated with a given VPN profile. It also includes installed packages that share a UID with applications added to the VPN profile.

```APIDOC
## GET /getAllPackagesInVpnProfile

### Description
Returns the list of packages that were added to the VPN for the specified profile. This API also includes installed packages that share a Unique User ID (UID) with the applications that are added to the VPN profile. The API should be used after creating a VPN connection.

### Method
GET

### Endpoint
N/A (Method call: `getAllPackagesInVpnProfile`)

### Parameters
#### Query Parameters
- **profileName** (String) - Required - The name of the profile for which to retrieve packages.

### Request Example
```java
EnterpriseKnoxManager ekm = EnterpriseKnoxManager.getInstance(context);
GenericVpnPolicy gm = ekm.getGenericVpnPolicy("com.vpn.vendor.packageName", userId);
String[] packages = gm.getAllPackagesInVpnProfile("profileName");
```

### Response
#### Success Response (String[])
- **return_value** (String[]) - An array of package names associated with the VPN profile, or null if the profile does not exist.

#### Response Example
```json
{
  "return_value": ["com.example.app1", "com.example.app3"]
}
```

### Permission
Requires `com.samsung.android.knox.permission.KNOX_VPN_GENERIC` permission.

### Since
API level 9, KNOX 1.1.0
```

--------------------------------

### EnrollmentProfile Constructors

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/keystore/EnrollmentProfile

Details on the constructors available for the EnrollmentProfile class.

```APIDOC
## Public Constructors

#### public EnrollmentProfile ()
Since: API level 12
```

--------------------------------

### Start GPS Service (Android)

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/location/LocationPolicy

This code example demonstrates how an administrator can start the GPS service on a device. It obtains the Enterprise Device Manager and its LocationPolicy, then calls `startGPS(true)` to initiate the service. The success or failure of this action is logged, and a SecurityException is handled if the necessary permissions are not met.

```java
EnterpriseDeviceManager edm = EnterpriseDeviceManager.getInstance(context);
LocationPolicy locationPolicy = edm.getLocationPolicy();
try {
        boolean result = locationPolicy.startGPS(true);
        if (result == true) {
                Log.d(TAG, "Start GPS success !!!");
        } else {
                Log.d(TAG, "Start GPS success fail !!!");
        }
} catch (SecurityException e) {
        Log.w(TAG, "SecurityException: " + e);
}
```

--------------------------------

### SdpDomain Constructor

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/sdp/core/SdpDomain

Details on how to create an instance of the SdpDomain class.

```APIDOC
## Public Constructors
####  public  SdpDomain (String alias, String pkgName)
Since: API level 19
Deprecated in API level 33
Construct a new SdpDomain object with the given parameters.
**Usage:**
An application developer can use this constructor to create an instance of the object.
```

      SdpDomain sdpDomain 	= new SdpDomain(alias, packageName);


```
##### Parameters
alias | A unique `String` identifier for `SdpEngine`.
pkgName | Application package name.
##### Since
API level 19
---
KNOX 2.6
##### Multiuser Environment
User Scope
---
##### See Also
  * `getAlias()`
```

--------------------------------

### CMPProfile Constructors

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/keystore/CMPProfile

Provides information about the constructors for the CMPProfile class.

```APIDOC
## Constructors

### CMPProfile()
Default constructor for CMPProfile.

```

--------------------------------

### GET /getAllContainerPackagesInVpnProfile

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/net/vpn/GenericVpnPolicy

Retrieves a list of containerized applications associated with a VPN profile. It also includes packages installed within containers that share a UID with applications in the VPN profile.

```APIDOC
## GET /getAllContainerPackagesInVpnProfile

### Description
Retrieves the list of containerized applications belonging to the specified VPN profile. It also returns packages installed inside containers that share a Unique User ID (UID) with applications added to the VPN profile.

### Method
GET

### Endpoint
N/A (Method call: `getAllContainerPackagesInVpnProfile`)

### Parameters
#### Path Parameters
- **containerId** (int) - Required - The ID of the container.
- **profileName** (String) - Required - The name of the VPN profile.

### Request Example
```java
EnterpriseKnoxManager ekm = EnterpriseKnoxManager.getInstance(context);
GenericVpnPolicy gm = ekm.getGenericVpnPolicy("com.vpn.vendor.packageName", userId);
String[] packages = gm.getAllContainerPackagesInVpnProfile(containerID, "profileName");
```

### Response
#### Success Response (String[])
- **return_value** (String[]) - An array of package names, or null if no packages are found.

#### Response Example
```json
{
  "return_value": ["com.example.app1", "com.example.app2"]
}
```

### Throws
- **SecurityException**: If the caller does not have the required permissions. Only the administrator who created the container can enforce the policy. If the calling administrator is not the owner of the container, a `SecurityException` is thrown.
- **IllegalArgumentException**: If the container does not exist or is currently being created or removed.

### Permission
Requires `com.samsung.android.knox.permission.KNOX_VPN_GENERIC` permission.

### Since
API level 9, KNOX 1.1.0
```

--------------------------------

### Get Certificate Alias

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/keystore/CertificateInfo

Retrieves the alias associated with an installed certificate. For certificates stored in the 'Android Default Keystore', this method returns null.

```java
String alias = certificateInfo.getAlias();
```

--------------------------------

### CMCProfile Class Constructors and Methods

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/keystore/CMCProfile

Information on the CMCProfile constructor and its methods, including inherited methods from EnrollmentProfile and Object.

```APIDOC
## Constructors

#### `public CMCProfile()`

*   Default constructor for CMCProfile.

## Methods

### `public String getProfileType()`

*   **Description:** Returns the profile type.
*   **Returns:** The profile type as a String.

### Inherited Methods from `com.samsung.android.knox.keystore.EnrollmentProfile`

#### `public String getCertificateAlias()`

*   **Description:** Returns the Certificate alias used for installing the certificate.
*   **Returns:** The certificate alias.

#### `public String getKeyPairAlgorithm()`

*   **Description:** Returns the key pair algorithm used for generating the key pair.
*   **Returns:** The key pair algorithm.

#### `public int getKeySize()`

*   **Description:** Returns the key size for generating the key pair (Optional).
*   **Returns:** The key size.

#### `public String getKeystoreType()`

*   **Description:** Returns the keystore used to store certificates.
*   **Returns:** The keystore type.

#### `public abstract String getProfileType()`

*   **Description:** Abstract method to return the profile type.
*   **Returns:** The profile type.

#### `public void setCertificateAlias(String certificateAlias)`

*   **Description:** Sets the Certificate alias used for installing the certificate.
*   **Parameters:**
    *   `certificateAlias` (String) - The certificate alias to set.

#### `public void setKeyPairAlgorithm(String keyPairAlgorithm)`

*   **Description:** Sets the algorithm for generating the key pair (Optional).
*   **Parameters:**
    *   `keyPairAlgorithm` (String) - The key pair algorithm to set.

#### `public void setKeySize(int keySize)`

*   **Description:** Sets the key size for generating the key pair (Optional).
*   **Parameters:**
    *   `keySize` (int) - The key size to set.

#### `public void setKeystoreType(String keystoreType)`

*   **Description:** Sets the keystore used to store certificates.
*   **Parameters:**
    *   `keystoreType` (String) - The keystore type to set.

### Inherited Methods from `java.lang.Object`

*   `clone()`
*   `equals(Object arg0)`
*   `finalize()`
*   `getClass()`
*   `hashCode()`
*   `notify()`
*   `notifyAll()`
*   `toString()`
*   `wait(long arg0, int arg1)`
*   `wait(long arg0)`
*   `wait()`

### Inherited Methods from `android.os.Parcelable`

#### `public abstract int describeContents()`

*   **Description:** Describe the kinds of special objects contained in this Parcelable's marshalled representation.
*   **Returns:** A bitmask indicating the set of special object types marshalled by this Parcelable instance.

#### `public abstract void writeToParcel(Parcel arg0, int arg1)`

*   **Description:** Flatten this object into a Parcel.
*   **Parameters:**
    *   `arg0` (Parcel) - The Parcel in which the object should be written.
    *   `arg1` (int) - Additional flags for how the various components of this parcelable should be written. (See `writeToParcel` options.)
```

--------------------------------

### Activity and Intent Management in Android Context

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/net/vpn/serviceprovider/GenericVpnService

Functions for launching activities, including starting a single activity or multiple activities with optional bundle arguments. Also supports starting intents via IntentSender.

```java
void startActivity(Intent arg0)
void startActivity(Intent arg0, Bundle arg1)
void startActivities(Intent[] arg0, Bundle arg1)
void startActivities(Intent[] arg0)
void startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4)
void startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4, Bundle arg5)
```

--------------------------------

### SPDControlPolicy Methods

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/restriction/SPDControlPolicy

Contains methods to get and set the security policy update mode. These methods are deprecated starting from API level 27.

```APIDOC
### Methods
---
int | getAutoSecurityPolicyUpdateMode() _Deprecated in API level 27_
boolean | setAutoSecurityPolicyUpdateMode(int mode) _Deprecated in API level 27_
```

--------------------------------

### SimInfo Class Documentation

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/deviceinfo/SimInfo

Provides detailed information about the SimInfo class, its fields, constructors, and inherited methods.

```APIDOC
## Class Overview
This class contains information on the SIM card.

##### Since
API level 2

---
MDM 2.0

## Fields
#### public String countryIso
Since: API level 2
ISO country code equivalent for the SIM provider country code

##### Since
API level 2

---
MDM 2.0

#### public String operator
Since: API level 2
MCC+MNC of the SIM card provider

##### Since
API level 2

---
MDM 2.0

#### public String operatorName
Since: API level 2
Service provider name

##### Since
API level 2

---
MDM 2.0

#### public String phoneNumber
Since: API level 2
SIM phone number.

##### Since
API level 2

---
MDM 2.0

#### public String serialNumber
Since: API level 2
SIM serial number.

##### Since
API level 2

---
MDM 2.0

## Public Constructors
#### public SimInfo ()
Since: API level 2
Default Constructor

##### Since
API level 2

---
MDM 2.0
```

--------------------------------

### Get Certificate Enrollment Status

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/keystore/EnterpriseCertEnrollPolicy

Retrieves the current status of a certificate enrollment or renewal process using a provided transaction ID. This method is deprecated starting from API level 30.

```APIDOC
## GET /api/certificate/status/{transactionId}

### Description
Retrieves the status of a certificate enrollment or renewal using the provided transaction ID. The transaction ID is returned by `enrollUserCertificate` or `renewUserCertificate`.

### Method
GET

### Endpoint
/api/certificate/status/{transactionId}

### Parameters
#### Path Parameters
- **transactionId** (String) - Required - Unique transaction ID returned by enrollment or renewal methods.

### Response
#### Success Response (200)
- **status** (int) - The status code of the certificate enrollment. Possible values include `CERT_SUCCESS`, `ERROR_CERT_FAILURE`, `ERROR_CERT_PENDING`.

#### Response Example
```json
{
  "status": 0
}
```

### Throws
- **SecurityException** - If the caller lacks the required permissions.

### Deprecated
Deprecated in API level 30. Use alternative methods if available.
```

--------------------------------

### getQuickPanelItems

Source: https://docs.samsungknox.com/devref/knox-sdk/reference/com/samsung/android/knox/custom/SystemManager

This method gets the quick panel items. It returns a list of integers specifying the current quick panel items.

```APIDOC
## GET /quickPanelItems

### Description
Retrieves the current configuration of quick panel items.

### Method
GET

### Endpoint
/quickPanelItems

### Parameters
#### Query Parameters
- None

#### Request Body
- None

### Request Example
```
// No request body for GET requests
```

### Response
#### Success Response (200)
- **items** (List<Integer>) - A list of integers representing the quick panel items.

#### Response Example
```json
{
  "items": [1, 3, 5]
}
```
```
Tokens:
Raw