RapidIdentity Cloud Product Guide

Installation

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

To begin the installation, ensure to log in as a local administrator on the device. Then, follow the steps for the corresponding installation option.

Interactive Installation

Note

For Domain-Joined (v. Non-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. Download and then right-click on the RapidIdentity Client for Windows.msi file to install, then click Next on the Windows Setup Wizard to begin the installation.

    Step_1.png

  2. Fill in the following fields as noted below.

    Configuration.png

    1. The Domain that the accounts will authenticate to

      Note

      Use DOT (.) to use a local account in a Non-Domain-Joined installation or the NetBIOS name of the Domain in the Domain field in a Domain-Joined installation.

    2. The Server URL

    3. The API Key generated from RapidIdentity Server

      Note

      For details on generating the API Key from RapidIdentity Server, refer to Service Identities.

  3. Select the folder in which the file is to be installed and click Next.

    Step_4.png

  4. Click Install on the Ready to install window.

    Ready_to_Install.png

  5. Click Yes to allow this app to make changes to the device if applicable.

    Make_changes.png

  6. Once the installation is complete, click Finish to exit the Setup Wizard,

    Install_complete.png
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=<provide your API key>

  • Set the URL: SERVER_URL=<provide your RI Server URL>

  • Set the Domain: DOMAIN=<provide your domain or enter DOT/PERIOD (.) to use a local account>

  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:

    • msiexec /i "RapidIdentity Client for Windows.msi" APIKEY=<provide your api key> SERVER_URL=<provide your RI Server URL> DOMAIN=<provide your domain or enter DOT/PERIOD (.) to use a local account> /qn /forcerestart

    The install will proceed silently and will only reboot the device if /forcerestart is added to the command line. See msiexec help for additional details and options.

In this section: