Secure Your WorkforceSecure Your CustomersAPI ReferenceEnd User GuideSupport

Installation and Configuration

Client Installation

HYPR Workforce Access for Windows can be installed silently or using the installer user interface. Administrative access to the target workstation is required and a new registry key will be created by a successful installation.

Silent Install

The HYPR Workforce Access Client can be installed on the command line using msiexec.

Command Line Parameters

Parameter NameDescriptionValuesDefault
HYPRAPPIDThe application ID as specified in the Control CenterA character array [0..256]No default. Mandatory Field.
HYPRRPThe URI of the Control Center. Replace your.domain.here with your domain in the example URI below:

https://<your.domain.here>/rp

This URI must end in /rp		A character array [0..256]No Default. Mandatory Field.
HYPRSUPPORTThe email address where support requests will be mailedA valid email addressNo Default. Optional.
HYPRHASHThe SHA1 or SHA256 PIN Hash of the server SSL certificate. This serves as the Public Key Pinning value.A SHA1 hash of the server SSL certificate.No Default. Mandatory.
HYPRTEMPLATECertificate template nameA valid certificate template nameDefault is User template. Optional.
HYPRINSTALLTOKENInstallation Token used for endpoint protectionA valid InstallToken generated in the Control CenterNo Default. Mandatory.
HYPRCUSTOMLOGOCompany logo displayed in the app.Path to an imageHYPR Images are set by default. Optional.
HYPRCUSTOMBACKGROUNDCustom background image displayed in the app.Path to an imageHYPR Images are set by default. Optional.

You can learn more about additional parameters that could be configured during the installation in this page.

📘

Example Installation

From a command prompt with administrative privileges

msiexec.exe /qn /i .\EmployeeAccess.msi HYPRAPPID="WindowsUnlock" HYPRRP="https://my.host.com/rp" HYPRSUPPORT="[email protected]" HYPRHASH="abcdef...fedcba" HYPRTEMPLATE="HYPRUser" HYPRINSTALLTOKEN="c8d2rf05b-b6db-4bc3-ateb-abb6302c48fd" HYPRCUSTOMLOGO="C:\\foo\\bar" HYPRCUSTOMBACKGROUND="C:\\foo\\bar"

❗️

CAUTION

  • The Alternate Subject Name must include the User Principal Name (UPN) in the certificate template

  • Default user template User will be used if HYPRTEMPLATE parameter wasn't specified

  • The installer file name shall not be changed unless otherwise noticed by HYPR.

Installer user interface

Rather than performing a silent install, you can use the installer wizard provided by HYPR. Double click the .msi installer provided to you by HYPR. You will see the installer user interface Window

  1. Click Next
988
  1. Accept the End User Agreement Terms
495
  1. Enter installation parameters
984
  1. If any of the parameters do not meet their required criteria, a warning message will pop up.

Certificate Template can be left blank to make use of default user templates or if you're deploying HYPR in a non-domain joined environment.

335
  1. Click Install
495

When the installation finishes, you'll be prompted to restart the workstation to complete the installation if necessary.

362

📘

Upgrading without reboot

When upgrading, a workstation reboot is only required for major updates. HYPR will notify customers about versions that will require a reboot.

Registry Keys

The installation adds a new HYPR key to the Windows Registry at the following location:

HKEY_LOCAL_MACHINE\SOFTWARE\HYPR Workforce Access

These registry values are required for normal functioning of the application.

NameDescription
Application IDThe application ID specified during installation. If you do not specify one this will be blank. This can be updated afterwards by an admin.
Machine IDA unique identifier for the workstation. This should never be changed
Public Key PinningSHA1 hash of the server SSL certificate
Relying Party UrlThe URI as provided by the installer
Support EmailThe support email for your organization
Certificate TemplateCertificate template name
Recovery Pin TextThe text message displayed on the login screen when the user clicks "Don't have your phone?"

Updated 6 months ago