Overview
This article will guide you through the process of configuring the license for Princeton Identity's Identity Server (IDS). A valid, up-to-date license is required to enable all features of the IDS and any connected devices. Without a license, biometrics cannot be enrolled, and new devices cannot be added to the system. License configuration must be performed for IDS version 2.16.0 and later.
For a new IDS installation, the license activation will be encountered during the first time server setup. If you encounter this page during the first-time setup, skip to the "Activation" section.
For an existing IDS installation, you must first navigate to the "Licensing" page.
If you are using a Windows based IDS, the ethernet adapter must appear on the IDS Network page as "Ethernet" or "eth0" instead of the default "Ethernet0". This name can be edited in Windows, and then the IDS must be restarted for the change to appear.
Navigating to the licensing page
Log in to the IDS web page using a user with the admin role. On the "Home" page click on the "Settings" tab at the top, or the "Settings" link on the right.
On the "Settings" page click on "Licensing" on the left hand side.
Activation
Activation of the IDS license requires the activation token provided with your software download and a connection to the internet. Each IDS will have its own activation token. It is recommended that the online activation method be attempted prior to moving to the Offline Activation steps. To connect to the license server "https://api.keygen.sh/" must be whitelisted on your network. Additional instructions for establishing a connection are provided in the following Keygen article. If you are unable to connect to this service, please proceed to the section titled Offline Activation below.
https://keygen.sh/docs/api/connectivity/#connectivity
The activation token provided with your software download contains two sections: the "License Key" and the "Activation Token". The license key contains multiple lines and starts with "key" and ends with "==". The activation token is one line and starts with "activ".
Please copy and paste the license key into the "License Key" text box, and the activation token into the "Activation Token" box. Please make sure that there are no extra characters, spaces, lines, or other text before or after the provided text. Extra characters will cause the activation to report the error "IDS license key not found on server". Note that each activation token can only be used on one Identity Server.
When the key and token are copy and pasted properly, click "ACTIVATE".
This will activate your IDS license. You will see a green check mark and the text "Valid IDS license", as well as the expiration date of your license and the number of devices that can be connected to your IDS.
Offline Activation
If the IDS is unable to connect to the internet for licensing, then the activation token method described above cannot be used. After updating your Identity Server, navigate to the "Licensing" page under the "Settings" tab.
Click on the "Offline Activation" link beneath the text boxes.
On the "Offline Activation" screen, next to "Host Id" click on the "Download" link.
This will download a text file to your computer which starts with "ids". Attach this text file to an email and send it to support@princetonidentity.com. In the email please reference your company name, the name of the end customer (if applicable), and the purpose of the Identity Server (test, production, secondary, etc.).
You will receive an email in return with a file called "PI.lic" attached. Please note that a response may take hours.
Download this license file to your computer. On the "Licensing" page, click on "Browse for file..." next to "License File". In the pop up select the "PI.lic" file that was downloaded and click "Open".
This will activate your IDS license. You will see a green check mark and the text "Valid IDS license", as well as the expiration date of your license and the number of devices that can be connected to your IDS.