• 06 Mar 2024
  • 2 Minutes to read
  • Dark


  • Dark

Article summary

Installation of RapidIdentity Client for Windows can be done interactively or silently by using command-line installation options.

To begin both installation options, one must be logged in as a local administrator on the device. Then, follow the steps for the corresponding installation option below.

RapidIdentity Client for Windows is for RapidIdentity Cloud only and is not meant for on-premise systems. Installing the RapidIdentity Client for Windows requires an API Key from the RapidIdentity Cloud tenant. An API Key is associated with a Service Identity in RapidIdentity. Instructions for creating a Service Identity are here.

Interactive Installation

For Domain-Joined installments, the following prerequisites are required:

  • Available Authentication into RapidIdentity Cloud version 2021.7.27 or later (base requirement for all)
  • Windows 10 Machine must be domain-joined
  • Users' identities exist in both the RapidIdentity User Store and Active Directory with synced passwords
  • An API key has been assigned to the Authentication API Consumer role for the appropriate Service Identity (base requirement for all)

  1. To prepare to install the latest version of the RapidIdentity Client for Windows, please download the Installer via the link below. Once the RapidIdentity Client for Windows installer is downloaded, right-click on the file to install.

  1. When presented with the Windows Setup Wizard, click Next to begin the installation.

  2. Fill in the following fields as noted below.Click 'Next' when complete.
    1. Domain: Accounts will authenticate to this domain. NOTE: Use DOT (.) to use a local account in a Non-Domain-joined installation or the NetBIOS name of the Domain in a Domain-joined installation.
    2. Server URL: Server URL
    3. API Key: Secret API Key generated in RapidIdentity Service Identities Server.
      1. For further details on where to locate the Secret Key, see Step 6 of this article.
  3. Select the folder in which the file is to be installed and click Next.
  4. Click Install on the Ready to install window.
  5. Click Yes to allow this app to make changes to the device if applicable.
  6. Once the installation is complete, click Finish to exit the Setup Wizard.

Command-Line Installation

From an administrative command prompt (or remote deployment package), execute the RapidIdentity Client for Windows install with the required command-line options. Below are the minimum values that need to be configured.

  • Set API Key: APIKEY=
  • Set the URL: SERVER_URL=
  • Set the Domain: DOMAIN=
  1. To install using the command line, open the Command Prompt and right-click on it from under the "Best match" section, and select Run as administrator.
  2. Navigate to the location where the "RapidIdentity Client for Windows.msi" file is located, and execute the following command. The install will proceed silently and will only reboot the device if /forcerestart is added to the command line. 
msiexec /i "RapidIdentity Client for Windows.msi" APIKEY=

Deploying the Windows Client with Command Line Parameters

The Windows Client provides a mechanism to automate installation via the command line for administrative installations. This information could be used by administrators to create a Command Line script that is run during user login on machines the client should be installed on.

  1. Download the Windows Client Installer via the link at the top of this article.
  2. Open the command prompt as an admin user on the Windows 10 machine.
  3. Run the following command: 
msiexec.exe /i "RapidIdentity Client for Windows.msi" /quiet /passive APIKEY="


Once the command has been run, the installation process starts in the background. However, it can be tracked in Task Manager if desired.

The Windows Client should proceed to install and should be present on the appropriate machines upon completion.

Please Note:

The Windows Authentication Client does not support the Remote Desktop Protocol.

Was this article helpful?

What's Next

Eddy AI, facilitating knowledge discovery through conversational intelligence