Customizing the IDSecurity Agent

The IDSecurity Agent supports several optional device-level customizations through a JSON file named customizations.json. Using this file, you can adjust the agent's authentication behavior, personalize the MFA prompt, control logging, and set operating-system-specific options. The sections below explain how to apply the file and describe the parameters you can set. You can also use the json builder tool below to interactively create your json file and download it directly from here.

How to configure

You can apply customizations.json in either of these ways:

• At deployment, during installation or upgrade: place customizations.json in the same folder as the installer. The installer detects the file and picks it up automatically.
• After installation: the active customizations.json is located at <InstallationPath>/conf. Edit it there with Local Administrator (root on Linux) privileges.

The installed file is located at:

• Windows: C:\Program Files\ManageEngine\Identity360 Cloud IDSecurity Agent\conf\customizations.json
• macOS: /Library/ManageEngine/Identity360 Cloud IDSecurity Agent/conf/customizations.json
• Linux: /opt/ManageEngine/Identity360CloudIDSecurityAgent/conf/customizations.json

Parameters reference

The following parameters apply to all platforms, except where a section is marked platform-specific.

Authentication and MFA

UI and personalization

Logging

Windows-specific parameters

macOS-specific parameters

The following keys are read only during installation and are discarded afterward. They are not written into the installed conf/customizations.json:

Linux-specific parameters

PAM prompt types

• placeholder (default): All MFA prompts and text are placed inside the text box's placeholder. QR codes are not supported in this mode, which matters for authenticators such as SAML, Duo Security, or mobile device passkeys, though the Magic Link short URL can still be used. Best suited to short prompts, such as time-based OTPs.

  

• info: All MFA prompts and text are shown below the text box as information. The drawback is that the text is erased when the user starts typing and is not shown again, which can confuse users or make them forget the options.

  

• both: MFA prompts and text appear both inside the text box's placeholder and as information below it. This balances the drawbacks of the other modes, but makes the login screen more crowded and can look duplicated. Prefer this when you have longer text, such as long security questions.

  

Samples

Windows sample

Refer to the common and Windows-specific parameters above to understand the usage before you use this sample.

{
  "log_archive_path": "C:\\Program Files\\ManageEngine\\Identity360 Cloud IDSecurity Agent\\logs\\archive",
  "log_level": "INFO",
  "log_path": "C:\\Program Files\\ManageEngine\\Identity360 Cloud IDSecurity Agent\\logs",
  "log_rotation_max_size": "50",
  "title": "IDSecurity Agent",
  "webclient_favicon_path": "C:\\Program Files\\ManageEngine\\Identity360 Cloud IDSecurity Agent\\resources\\favicon.ico",
  "whitelisted_urls": [
    "login.microsoftonline.com",
    "microsoft.com",
    "accounts.google.com",
    "duosecurity.com"
  ],
  "bypass_on_connection_error": "true",
  "offline_mfa_logo": "id-access.png"
}

macOS sample

Refer to the common and macOS-specific parameters above to understand the usage before you use this sample.

{
  "webview_width": 0,
  "webview_height": 0,
  "log_path": "/Library/Logs/Identity360 Cloud IDSecurity Agent",
  "log_archive_path": "/Library/Logs/Identity360 Cloud IDSecurity Agent/archive",
  "log_rotation_max_size": "50",
  "log_level": "INFO",
  "title": "IDSecurity Agent",
  "whitelisted_urls": [
    "login.microsoftonline.com",
    "duosecurity.com",
    "accounts.google.com",
    "microsoft.com"
  ],
  "bypass_on_connection_error": true,
  "pam_prompt_type": "both",
  "mfa_scenarios": 0,
  "lock_screen_authentication": true,
  "offline_mfa_logo": "id-access.png"
}

Linux sample

Refer to the common and Linux-specific parameters above to understand the usage before you use this sample.

{
  "log_level": "INFO",
  "log_path": "/opt/ManageEngine/Identity360CloudIDSecurityAgent/logs",
  "log_archive_path": "/opt/ManageEngine/Identity360CloudIDSecurityAgent/logs/archive",
  "log_rotation_max_size": "50",
  "title": "IDSecurity Agent",
  "bypass_on_connection_error": "true",
  "mfa_scenarios": "0",
  "pam_prompt_type": "both",
  "whitelisted_urls": [
    "login.microsoftonline.com",
    "duosecurity.com",
    "accounts.google.com",
    "microsoft.com"
  ]
}

Build your customizations.json

Instead of creating the json file manually in a text editor you can use the json builder tool below. Choose your OS, add the attributes you need, set their values, then copy or download a ready-to-use customizations.json.

{}