This article explains the command-line tool included in Beyond Identity Authenticator for Windows (version 2.99.0 and later), which provides commands for installing, uninstalling, managing updates, configuring version control, restarting authenticators, and saving logs, with support for both user- and system-level installations and MDM deployments.
Starting in version 2.99.0, the Windows installer includes a command-line tool that supports a list of instructions for the Windows authenticator. This tool also helps support MDM deployments. The tool is available after installing the authenticator at:
User install location: C:\User\username\Local\Programs\BeyondIdentity\Tools
System install location: C:\Program Files\BeyondIdentity\Tools.
Some instructions require Administrator access, so they will require the user to run the command prompt as an administrator.
The following table describes the available commands.
Command | Description |
|---|---|
./BIConfigure --help | Lists the available commands to the console. |
./BIConfigure --version | Lists the installed versions of the Beyond Identity Authenticator and specifies whether it is a User or System install. |
./BIConfigure --uninstall | Uninstalls the Beyond Identity Authenticator. If no parameter is specified, the version where the BIConfigure tool is located is uninstalled. If the User or System is specified, then that particular type of installation is uninstalled. Note: Uninstalling the System install requires Administrator privileges. |
./BIConfigure --disable-updates | Disables discovery and installation of Beyond Identity Authenticator updates. |
./BIConfigure --enable-updates | Enables discovery and installation of Beyond Identity Authenticator updates; required for version control. Requires Administrator privileges |
./BIConfigure --show-updates | Displays whether updates through Beyond Identity are enabled or disabled in the console. |
./BIConfigure—set-version-control-id <id> | Sets the Version Control ID. Requires Administrator privileges |
./BIConfigure --get-version-control-id | Displays the Version Control ID to the console. |
./BIConfigure --clear-version-control-id | Removes the version control ID. Requires Administrator privileges |
./BIConfigure --set-version-control-url <url> | For customers whose Beyond Identity data center is hosted outside the United States, there is an additional registry entry that you must configure: VERSION_CONTROL_URL. Contact Beyond Identity Support for instructions. Requires Administrator privileges |
./BIConfigure ----get-version-control-url <url> | Gets the version control URL for customers whose Beyond Identity data center is hosted outside the United States. |
./BIConfigure ----clear-version-control-url <url> | Removes the version control URL for customers whose Beyond Identity data center is hosted outside the United States. Requires Administrator privileges |
./BIConfigure --restart-authenticators | Restarts all running Beyond Identity Authenticators. |
./BIConfigure --save-logs | Creates a zip file that contains all of the necessary log files. The zip file is created in the directory where the command is run. |