Knox SDK frequently asked questions — Licensing
Although the process varies between SDKs, the main steps are:
- Obtain a license key.
- Prepare your app with the necessary license key handling logic.
- Activate the license key.
For implementation details, see About licenses.
It is a commercial key that you need to use in conjunction with the Knox Platform for Enterprise (KPE) key on devices running Knox v2.7.1 or earlier. You can generate a single backwards compatibility key to use with multiple KPE keys.
If you want to use the KPE key, you need to do two things:
Activate the KPE key by calling the API method KnoxEnterpriseLicenseManager.activateLicense. This asks for permission to use API methods from select SDKs.
Activate the backwards compatible key by calling the API method EnterpriseLicenseManager.activateLicense. This sends the request to a Samsung License Server. The backwards compatible key itself has no permissions.
The order in which you activate the KPE key and backwards compatible key does not matter.
You need to activate a backwards compatible key in the following cases:
|Knox 2.8 or higher||Knox 2.7.1 or lower|
|KPE Standard (KLM09)||BCK not required||BCK required|
|Legacy KPE Premium (KLM03, KLM06)||BCK required||BCK required|
|KPE Premium (KLM09)||BCK not required||BCK required|
BCK is not required if your:
device’s Knox version is 2.8 or higher
KLM On-Premises version is 2.3 or higher
license key is new (issued in 2020 or after)
For all the other cases, BCK is required.
If EMM server activates both KPE Standard key and BCK, it works well for all version devices even IT Admin inserts any KPE premium KLM09 key or KLM03. To get more information about the backwards compatible key, see What is the backwards compatible key? and Do I need to associate my app with a backwards compatible key?.
Apps can no longer activate ELM licenses on devices to call Knox APIs. Existing ELM key activated devices will remain activated, even after a factory reset. For more information, see the ELM License End of Service FAQ section.
Backwards Compatible Key must be activated after KPE key activation.
For more information on license activation, see Activate a license.
No, you do not need to associate your app with a backwards compatible key.
Please refer to the table below for an explanation of how license key names have changed over time:
|SDK||License Key Name||Note|
|Legacy (Separate)||Current & Going Forward (Unified)||Legacy (ELM/KLM)||Current & Going Forward (SKL)|
|Knox Standard SDK||Knox SDK||ELM key (free)||KPE Standard key (free)|
|Knox ISV SDK||ELM ISV SDK key (free)||KPE Standard key (free)|
|Knox UCM SDK||ELM UCM SDK key (free) + KLM Workspace key (paid)||KPE Premium key (paid)||UCM SDK permissions have been merged into KPE Premium (they became paid permissions)|
|Knox Customization SDK||KLM Customization SDK key (paid)||KPE Premium key (paid)||Customization SDK permissions have been merged into KPE Premium|
|Knox Premium SDK||KLM Workspace key (paid)||KPE Premium key (paid)|
|Knox Tizen SDK for Wearables||ELM key (free) + KLM Customization SDK key (paid)||KPE Standard key (free) + KPE Premium key (paid)|
The KPE Development key is available for KPP users to trial all of the KPE Premium permissions for a limited period of time.
In August 2017, the new Knox Platform for Enterprise (KPE) license replaced both the:
Enterprise License Management (ELM) license — This license grants apps the permissions to call APIs for free Knox features. ELM keys will undergo an End-of-Service, as described in When is the ELM license service terminated? and must be replaced, as described in What should I do if I want to service my app which uses an ELM license? by December 2021.
Knox License Management (KLM) license — This license grants apps the permissions to call APIs for paid Knox features. KLM keys will continue to work indefinitely; however, you can no longer get new license keys. To increase the number of paid activations on your existing KLM license, you must contact Samsung directly and cannot go through a Knox License reseller.
We highly recommend you to switch to the new KPE Premium license key, which offers greater flexibility in terms of:
- generating new development keys through the Knox Partner Portal Generating KPE Premium key
- purchasing additional license activations through Knox License resellers
Assuming that you have not hardcoded the KLM key into your app, you should not need to modify your app code. You just need to update your key values, for example, on a back-end web server or cloud storage service. Replace the:
ELM key with a Backwards Compatible Key, which gets passed to the existing API method EnterpriseLicenseManager.activateLicense
KLM key with a KPE key, which gets passed to the existing API method KnoxEnterpriseLicenseManager.activateLicense
For more detail, see About licenses, Get a license, Activate a license, and Declare Knox permissions. See also: What should I do if I want to service my app which uses an ELM license?
Existing ELM license keys are reaching End-of-Service. For more info, see:
Any KPE license key
You can use KPE license keys by themselves if your devices are running Knox 2.8 or higher.
Backwards compatible key + any KPE license key (KPE Development, KPE Standard, KPE Premium)
A single backwards compatible key may be activated with multiple KPE license keys.
Note that the backwards compatible key is required with the Knox Tizen SDK for Wearables and with the Knox SDK on devices running Knox 2.7.1 or lower.
ELM + Any KPE license key
The legacy Enterprise License (ELM) may be activated alongside any KPE license key (KPE Development, KPE Standard, KPE Premium). It supports all devices.
ELM + KLM
Only possible if you have existing ELM and KLM keys to activate.
By design, licenses are periodically and automatically revalidated. However, in certain cases (for example, if a device is offline for an extended period of time), automatic revalidation does not occur.
If a previously activated license is not validated for 180 days, the license assignment will be automatically released. Automatic license assignment release is not applied to licenses with unlimited assignments (Knox Platform for Enterprise Standard license and Knox Platform for Enterprise Premium license).
Permissions are the rights to use specific features of a Knox product. For a full list, see License permissions.
Is this page helpful?
Thank you for your feedback!