License Key

Overview

The License Key version 3.7 and version 3 REST Application Programming Interface (API), has a workflow to validate a license and a device by communicating to the License service in the HYPR network. For this workflow, a customer's network requires connectivity access to the public License Server. License Key version 3.8 does not have this requirement.

The API version 4 and License Key version 3.8, validates the license and device within the HYPR Control Center. By moving the validation from the License Server to the Control Center, the requirement to communicate with the License Server is removed. With this solution, we eliminate the customer's security risks in requiring connectivity between a customer and a public network.

Once your license expires, becomes corrupted, or is invalid for a new domain, the available features will be disabled. For example creating an application will display an invalid license message. For details on what to expect with an invalid license, see section 5 for troubleshooting.

To absorb the remainder of this document, there are some key terms with which you should become familiar. These terms help describe the following user cases:

Integration

If you are installing the HYPR Service for the first time, the process from getting your HYPR license to authenticating into an application has a set of steps. The steps for the version 4 API workflow include:

Admin and Engineering Tasks

  1. Requesting a License Key from HYPR Ops. 1
  2. Creating a Relying Party application or using and exiting one. 2
  3. Upgrading or integrating the Java SDK client to your website. This includes a version 4 QRCode. 3
  4. Upgrading or integrating the Workforce client to the computers. This also includes a version 4 QRCode. 4

First Time User Tasks

  1. Downloading the latest mobile HYPR (Android or iOS) application. 1
  2. Registering the mobile device to a web or workforce application. 2
  3. Authenticating to a website or workstation with the registered mobile device 3

Existing User Tasks

  1. Upgrading to the latest mobile HYPR(Android or iOS) application. 1
  2. Continue authenticating to pre-existing registered applications.

These workflows can be seen in the system architecture diagram in Figure 1.

System Architecture

FIGURE 1:
User cases mapped to the version 4 API. The API's in bold are affected by the V4 API workflow.

In addition to use cases, FIGURE 1 displays the correlation between the RP application and the rest of the system. The RP application is the data entity identifying web or workforce application. This application is tied to either a Windows workstation client, Mac workstation client, or web application client. After a mobile device is registered to an application, you can use the device to authenticate into that application.

Section two described the admin, engineering, user, and API workflows supported with the 3.8 License Key and version 4 API. What are some of the items you need for this integration? Section 3 will cover the requirements for this integration.

Prerequisites

To have a successful workflow of a 3.8 License Key without the license server, the listed services must be upgraded. If older versions of Java SDK, Windows Client, iOS App, and Android App are being used, that version workflow will be executed.

System Requirements for 3.8 License Key and API Version 4

Service

Version

API Version

Server Installer

3.8

4

Java SDK

3.8

4

Windows Client

2.8

4

iOS App

3.9

4

Android App

6.0

4

Server REST API Versioning and Workstation Compatibility

Compatibility

Android 5.0

Android 6.0

iOS 3.8

iOS 3.9

Workstation 2.8

Server 3.7

Server 3.8

RP App 3.8

βœ”οΈ

V4

V4

V4

V4

V3 and V4

❌
Mobile unable to recognize the V4 QR Code.

V3

V3

V3

V4

V4

V4

βœ”οΈ

V3

V3

V3

V3

V4

V4

βœ”οΈ

V4

V4

V4

V3

V3

V3

βœ”οΈ

V4

V4

V3

V3

V3

V4

βœ”οΈ

V4

V4

V3

V4

V3

βœ”οΈ

V3

V3

V3

V4

V3

V3

V3

Server REST API Versioning and Web Client Compatibility

Compatibility

Android 5.0

Android 6.0

iOS 3.8

iOS 3.9

Java SDK Client Pre 3.8

Java SDK Client 3.8

Server 3.7

Server 3.8

RP App 3.7

RP App 3.8

βœ”οΈ

V4

V4

V2

V2

V4

βœ”οΈ

V3

V3

V2

V2

V4

βœ”οΈ

V3

V3

V2

V2

V3

βœ”οΈ

V4

V4

V2

V2

V3

βœ”οΈ

V4

V4

V4

V4

V4

❌
Mobile unable to recognize the V4 QR Code.

V3

V3

V4

V4

V4

βœ”οΈ

V4

V4

V2

V2

V2

βœ”οΈ

V3

V3

V2

V2

V2

Supported format of license key:

Binary file with a .bin extension
Ex: "myLicense-4-17-2020.bin"

πŸ“˜

Upgrading from license 3.7 or older to 3.8

If you have an existing 3.7 License Key or older, leave the existing key in its vault location. This is to be compatible with the registration and authentication workflows of older versions.

Instructions and Guidelines

Adding New License Key

πŸ“˜

Use version 3.8.0+

Instructions below are written for version 3.8.0 and above

Step 1. Get a License Key File
Contact HYPR operations team. Provide the following information when requesting the key:

"version": 4, 
"name": "mylicense-1.1.0-release", 
"description": "CustomerDescription" ,
"domains": [ "*.first.com","*.second.com", "*.third.domain" ], 
"numOfUsers": 1000, 
"numOfDaysValid": 3650 

After receiving your license key file from the HYPR operations team, upload the license key file in the Control Center. HYPR supports a binary license file.

Ex: "myLicense-4-17-2020.bin"

Step 2. Navigate To The License Key Page

At startup, there are two options to upload the license key. The first option is the ADD LICENSE at the first drop down banner.

The second option is via the settings menu. Navigate to the license key page by following the bottom steps 1 and 1.1.

Step 3. Upload a License Key

Click on the gray area to upload a license key file.

Step 3. Validate and Submit a License Key

Upon uploading a file, the license key will be validated. If it is a valid license, you will see the banner below.

For an invalid license, a red message will appear.

Once the submit button is clicked, you will see the confirmation below.

Verify an Existing License Key

To verify your existing license, navigate to the license page. The valid domains associated with that license key will be displayed.

Troubleshooting

If there is an existing license and it is no longer valid, the feature to create new applications will be disabled. Editing existing applications will also be disabled. Both scenarios are displayed below.

Upgrade

License Key Renewal

If you find that you have an invalid license key or would like to renew to a newer version, please contact HYPR Customer Service and request a new key.

Updated 11 months ago

License Key


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.