Learn more about how our platform was built click here

Auto Configuration

Prev

Setting Up Auto Configuration for AuthX Windows Agent

Content List


Overview

This guide explains how to create and configure the Auto Configuration application for Windows agents in the AuthX platform. After setting up the Auto Configuration application, you'll enable Auto Configuration for the Windows agent and select the relevant Workstation Groups. The agent is then installed on the workstation, automatically applying the desired configurations, ensuring a consistent and automated setup across your organization's devices.

Required Access Level

Owner and Administrator

Prerequisite

Download the necessary Windows agent MSI file


Creating Auto Configuration Application

  1. Navigate to Applications → AuthX Applications → Protect Application.

  2. From the list of AuthX Applications, select Auto Configuration. 

    Note

    Only one Auto Configuration application can be created. Attempting to create a second one will result in an error.

  3. Enter the application details. The application name is set to Auto Configuration by default, but you can change it if needed.

  4. Optionally, specify a Category and apply a Policy as required.

  5. Save the application. 

  6. After saving the configuration, note down the following details:

    1. Application ID

    2. Application Key

    3. Application URL

  7. These details will be used in the next steps to configure the Windows Agent Application. After creating the Auto Configuration application, proceed to create Workstation Groups. Then, you can add the Auto Configuration and Workflow Groups for Windows applications as shown in the below step.


Step 1: Enable Auto Configuration for Windows Agent

  1. After creating the Auto Configuration application, a new option called Auto Configuration will appear under Windows Agent applications.

  2. The option will include an Enable/Disable toggle.

  3. If Auto Configuration is enabled, select the appropriate Workstation Group for the Windows application that needs to be auto configured.

    Note

    A Workstation Group can be selected under one Windows Agent Application.


Step 2: Install Windows Agent and Apply Configuration

Option 1:

  1. On the workstation where you wish to install the agent, open Command Prompt.

  2. Run the Installation Command use the following format:

msiexec /i "File Path of the downloaded Windows agent MSI file" APPID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" APPKEY="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" APPURL="https://apixxxx-{hostname}.authx.com"

3. Parameters:

  • APPID: Use the Application ID from the Auto Configuration application created earlier.

  • APPKEY: Use the Application Key from the Auto Configuration application.

  • APPURL: Use the Application URL from the Auto Configuration application.

  • File Path: Specify the File Path of the downloaded Windows agent MSI.

4. After executing the command, the Windows agent will be installed on the machine. The configurations of the windows application will be applied to the workstations in the selected workstation group.


Once the Windows agent installation is complete, the workstation will be automatically configured according to the settings specified for the Windows agent application in the AuthX Admin Portal.

Option 2:

Silent Configuration for AutoConfigApp.exe using Application Arguments:

After installing the AuthX Agent, you can manually configure AutoConfigApp by following these steps:

To configure AutoConfigApp.exe with the necessary parameters (App ID, App Key, and URL), follow these steps using an Administrator Command Prompt.

  1. Open the Command Prompt with Administrator privileges:  

    • Right-click on the Command Prompt shortcut and select "Run as administrator." and input the following command line:

"C:\Program Files\AuthX\AuthX Windows Agent\AutoConfigApp.exe" -i " APP ID OF AUTO CONFIG" -k " APP KEY OF AUTO CONFIG" -u "https://apixxxx-{hostname}.authx.com"
  1. Execute the command with the required parameters:  

    • In the Command Prompt, input the following command and replace the placeholders (<App ID>, <App Key>, <hostname>) with your specific values:

    • -i "<APP_ID>": Specifies the App ID for the AutoConfig application.

    • -k "<APP_KEY>": Specifies the App Key for the AutoConfig application.

    • -u "<URL>": Defines the API URL, where <hostname> should be replaced with your organization's hostname (e.g., us1, eu1, etc.).

  2. Verify the Configuration:  

    • After running the command, the workstation will be configured according to the settings specified for the Windows agent application in the AuthX Admin Portal. Ensure the process completes successfully.

Option 3:

Configuring AutoConfigApp After Installing the Agent

After installing the AuthX Agent, you can manually configure AutoConfigApp by following these steps:

  1. Navigate to the Installation Directory:  

    • Go to the following path where AutoConfigApp is located:

      Launch AutoConfigApp:  

      • Open AutoConfigApp.exe from the directory.

    • Enter Configuration Details:  

      • In the AutoConfigApp window, input the following information:  

        • Application ID: Copy and paste your AutoConfig App’s Application ID.

        • Application Key: Copy and paste your AutoConfig App’s Application Key.

        • Application URL: Copy and paste your AutoConfig App’s the Application URL (e.g., https://apixxxx-<hostname>.authx.com).

    • Save the Configuration:  

      • Once all fields are populated, click Save to apply the configuration.

This process will configure the AutoConfigApp with the necessary details to integrate the Windows Agent application configuration with your workstation.


Note

If you unselect a workstation group from one Windows Agent application and select it for another, the new configuration settings will be applied to the workstation upon its next system restart.