IDSecurity Agent installation via Endpoint Central

Here are the step-by-step instructions on how to deploy Identity360's IDSecurity Agent for Windows using ManageEngine Endpoint Central.

• System requirements
• Prerequisites
• Steps for installing the IDSecurity Agent on a Windows machine
• Step 1: Creating an MSI package
• Step 2: Customizing the IDSecurity Agent
• Step 3: Deploying an MSI package
• Step 4: Uninstalling the IDSecurity Agent
• Updating the Installation Key

This page will guide you through the steps involved in installing the Identity360 IDSecurity Agent using Endpoint Central. This document is written with the assumption that you are a system administrator with basic knowledge of ManageEngine Endpoint Central.

System requirements

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

Prerequisites

1. The MFA and SSO license for Identity360 is required to enable MFA for Windows logins. Visit our store for pricing details.
2. Currently, the IDSecurity Agent is supported only for Windows devices that are joined to Azure AD or are part of a hybrid AD setup.
3. Configure MFA settings located in the Identity360 admin portal before installing the IDSecurity Agent. Go to Applications > Multi-factor Authentication > MFA for Endpoints > MFA for Windows machines.

Steps for installing the IDSecurity Agent on a Windows machine

Step 1: Creating an MSI package

1. Log in to Endpoint Central as an admin.
2. Navigate to Software Deployment > Package creation > Packages > Add Package and select Windows.
3. On the Enter Package Details page, enter a Package Name, and click the MSI/MSP radio button.
4. Click the License Type drop-down and select Commercial.
5. In the Local installable field, select From Local Computer.
6. Click Browse and select the Identity360CloudIDSecurityAgent.msi file.

Note: Locate this file in Identity360's admin portal by navigating to Applications > Multi-factor Authentication > MFA for Endpoints > Install IDSecurity Agent > Step 1 > Download.


7. Locate and copy the Installation Key from the Identity360 admin portal, under Applications > Multi-factor Authentication > Install IDSecurity Agent > Step 2.

8. Back on the Enter Package Details page in Endpoint Central, enter Identity360CloudIDSecurityAgent.msi in the MSI/MSP File Name field.

9. Enter the Installation Key obtained from step 7 into the MSI/MSP Properties for installation field in the format shown below while replacing <KEY> with the copied Installation Key.
Installation command

Copy to Clipboard

INSTALLATION_KEY=<KEY>

Note: If a new installation key is generated, copy the command with the new installation key from the Identity360 admin portal and update the MSI/MSP Properties for installation field with the new command for all new installations.

10. Click Add Package.
11. You have now created a software package that you can deploy to the computers in your domain.

Step 2: 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 provided sample below. This file should contain the necessary parameters that require modification.

Upload the customizations.json file along with the MSI file by navigate to Software Deployment > Package creation > Packages > Add Package > Windows. Click Browse in the Locate Installable field on the Enter Package Details page to upload the file.

Note: If customization is not required, the MSI will automatically utilize the default parameters.

If you do not customize the file as mentioned in the previous step, you can still make adjustments later by editing the customizations.json file located in the C:\Program Files\ManageEngine\Identity360 Cloud IDSecurity Agent\conf folder.

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

{
 "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.

Step 3: Deploying an MSI package

1. Select the package you have created in the Packages tab. Select Computer Configuration from the Install/Uninstall Software drop-down.

2. On the Install/Uninstall Windows Software page that opens, enter a Name.
3. In the Define Target section, select the required domains and computers to which you'd like to deploy the MSI package.

4. Click Deploy Immediately.

Step 4: Uninstalling the IDSecurity Agent

1. Uninstalling the IDSecurity Agent for specific computers

The following steps can be used when it becomes necessary to remove the IDSecurity Agent from particular computer machines.

1. Log in to Endpoint Central as an admin.
2. Navigate to Inventory > Views > Software > IDSecurity Agent.
3. From the table, select the computer(s) from which the agent should be uninstalled.
4. Click on Uninstall.

2. Uninstalling the IDSecurity Agent from all machines

The following steps can be used to uninstall IDSecurity Agent across all machines.

1. Select the package you have created in Step 1.
2. Select Computer Configuration from the Install/Uninstall Software drop-down.

3. On the Install/Uninstall Windows Software page that opens, enter a Name.
4. Choose Uninstall as the operation type in the Install/Uninstall Software section.
5. In the Define Target section, select the required domains and computers.

6. Click Deploy Immediately to initiate the uninstallation process.

Updating the Installation Key

In case the current installation of the IDSecurity Agent is compromised, regenerate a new Installation Key by navigating to Applications > Multi-factor Authentication > Install IDSecurity Agent > Step 2 > Regenerate in Identity360 admin portal. Copy the command along with the newly generated key and follow these steps to update the Installation Key.

1. Log in to Endpoint Central as an admin.
2. Navigate to Software Deployment > Package creation > Packages and select the package created Step 1.

3. On the page that opens, select Modify from the Actions dropdown menu.

4. Replace the current Installation Key found at Installation > Installation Details > MSI/MSP Properties for installation on the Modify Package page with the new key copied from Step 3. Then, proceed to click on Modify Package.

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.

Previous Topic Next Topic