IDSecurity Agent manual installation

Here are the step-by-step instructions on how to manually deploy the Identity360's IDSecurity Agent for Windows.

System requirements

The different platforms supported by the IDSecurity Agent are listed below.

Windows servers Windows clients
Windows Server 2022 Windows 11
Windows Server 2019 Windows 10
Windows Server 2016 Windows 8.1
Windows Server 2012 R2 Windows 8

IDSecurity Agent installation

Manual installation

To install the IDSecurity Agent manually, you need to log in to each user machine individually and use either GUI or CLI methods to deploy the agent.

Prerequisites for manual installation:

  1. Identity360's MFA and SSO license is required to enable MFA for Windows logins. Visit our store for pricing details.
  2. Ensure a stable internet connection is available to connect user machines to the Identity360 portal.
  3. The technician who installs the IDSecurity Agent must be a member of the Local Administrator group or have Run as Admin privilege on the machine.
  4. Configure MFA settings located at Applications > Multi-factor Authentication > MFA for Endpoints > MFA for Windows machines in the Identity360 admin portal before installing the IDSecurity Agent.
  5. IDsecurity-agent-manual-installation

Using the GUI installer

Steps to install the agent with the setup wizard:

  1. Download the Identity360CloudIDSecurityAgent.msi file through Identity360's admin portal by navigating to Applications > Multi-factor Authentication > MFA for Endpoints > Install IDSecurity Agent > Step 1 > Download.
  2. Paste the MSI file onto the machine in which the IDSecurity Agent is to be installed.
  3. Right-click and run the MSI file as an administrator.
  4. Copy the Installation Key from the product UI. Locate the key in the Identity360 admin portal under Applications > Multi-factor Authentication > Install IDSecurity Agent > Step 2.
  5. Paste it into the Installation Key field in the setup wizard and click Next.
  6. IDsecurity-agent-manual-installation
  7. Follow the steps provided in the wizard and finish the installation process.

Using the CLI installation

The installation of the MSI can be performed silently without user interactions through the Command Prompt by utilizing the appropriate command with the required parameters. This method allows for a streamlined and automated installation process without the need for user interaction.

To achieve a silent installation of the MSI, refer to the steps outlined below:

  1. Download the Identity360CloudIDSecurityAgent.msi file through Identity360's admin portal by navigating to Applications > Multi-factor Authentication > MFA for Endpoints > Install IDSecurity Agent > Step 1 > Download.
  2. Paste the MSI file in the machine in which the IDSecurity Agent is to be installed.
  3. Copy the Installation Key from the product UI. Locate the key in the Identity360 admin portal under Applications > Multi-factor Authentication > Install IDSecurity Agent > Step 2.
  4. IDsecurity-agent-manual-installation
  5. Open the Command Prompt as an administrator and point it to the folder containing the installer file.
  6. Execute the following command, replacing <KEY> with the actual installation key obtained from step 3.
  7. Installation command
    Copy to Clipboard
    msiexec.exe /i "Identity360CloudIDSecurityAgent.msi" /qn INSTALLATION_KEY=<KEY>

Customizing the IDSecurity Agent

The customizations.json file is used to customize the IDSecurity Agent's default parameters. Before proceeding with the installation, ensure you prepare a customizations.json file similar to the sample provided below. This file should contain the necessary parameters that require modification. Place this file in the same path as the MSI file for customization. If customization is not required, the MSI will automatically utilize the default parameters.

If you have not prepared a customizations.json file during installation, you can still make adjustments by editing the file located at: C:\Program Files\ManageEngine\Identity360 Cloud IDSecurity Agent\conf\customizations.json

Note: Please refrain from making any modifications to any files aside from customizations.json found in the installation folder, as these files are integral to the functioning of the IDSecurity Agent. Any changes to these files may disrupt functionality of both the agent and the system.

Sample customizations.json file

JSON
{
 "LogPath": "C:\\Program Files\\ManageEngine\\Identity360 Cloud IDSecurity Agent\\logs",
 "LogLevel": "NORMAL",
 "LogRotationMaxSize": "50",
 "LogArchivePath": "C:\\Program Files\\ManageEngine\\Identity360 Cloud IDSecurity Agent\\logs\\archive",
 "Title": "IDSecurity Agent",
 "WebclientFaviconPath": "C:\\Program Files\\ManageEngine\\Identity360 Cloud IDSecurity Agent\\resources\\favicon.ico"			
}

The table below contains the list of default values and descriptions for all parameters.

Parameter Name Default Value Description
LogPath C:\Program Files\ManageEngine\Identity360 Cloud IDSecurity Agent\logs

The log file is stored here.

Caution: Modifying the value is advised only if there is a valid reason to do so. If the value is altered, ensure that the folder permissions include write permissions for the Users group and the SYSTEM account.

LogLevel NORMAL The default value is set to NORMAL, providing comprehensive information essential for regular operation. If the value is changed to DEBUG, the log will incorporate detailed troubleshooting information crucial for the support team. Exercise caution, as setting the value to DEBUG will generate extra log entries, potentially causing a rapid increase in the log file's size.
LogRotationMaxSize 50 This parameter determines the maximum size of the log file. Upon reaching the specified limit, with a minimum of 10MB and a maximum of 50MB, a new log file is generated, and the previous log file is archived to the path specified in LogArchivePath.
LogArchivePath C:\Program Files\ManageEngine\Identity360 Cloud IDSecurity Agent\logs\archive This refers to the file path where log files are archived once they reach the specified LogRotationMaxSize limit.
Title IDSecurity Agent Title of the MFA prompt.
WebclientFaviconPath C:\Program Files\ManageEngine\Identity360 Cloud IDSecurity Agent\resources\favicon.ico Icon of the MFA prompt.

Updating the Installation Key

Please regenerate a new Installation Key using the link in Identity360 admin portal if the current Installation Key is compromised. Follow these steps to regenerate a key:

  1. Log in to the Identity360 admin portal.
  2. Go to Applications > Multi-factor Authentication > Install IDSecurity Agent > Step 2 > Regenerate..
  3. After generating a new Installation Key, copy the command along with the new Installation Key from the Identity360 admin portal.
  4. Update the Installation Command field with the new command for all new installations.
Note:
  • Please treat the Installation Key like a password. It is sensitive information and must not be shared.
  • The generation of a new Installation Key will not affect the existing installations of the IDSecurity Agent on installed machines.

Troubleshooting

If you encounter any issues or need assistance resolving common problems, kindly visit our troubleshooting page for detailed guidance and solutions tailored to address your concerns.

Copyright © 2024, ZOHO Corp. All Rights Reserved.