Introduction
LogonBox Credentials Provider allows you to log in to your Windows machine with your LogonBox Directory credentials. The supported Windows versions are Windows 10 and 11.
Note: In this document, the LogonBox Credentials Provider is also referred to as the provider.
Prerequisites
You need a registration key to install and use the provider.
1. Log in to your LogonBox server as the admin.
2. Go to Authentication Flows -> Authentication Options -> Credential Provider.
3. Copy the Registration Key.
Downloading the Client
1. Log in to the LogonBox server as the admin to find the downloads for the LogonBox Credentials Provider.
These Microsoft Installer packages also provide support for unattended installs. No reboot is required in most cases.
2. Click the Downloads icon from the top-right of the page.
3. Download the relevant installation file.
Installing LogonBox Credentials Provider
1. Run the installer on your machine (with admin rights) which will start the setup wizard. Click Next on the first page.
This installs the prerequisite Visual C++ redistributable if required (if the pre-requisite is already installed, the installer will start with the following step).
2. Click Next to start the main setup.
3. Browse and select a directory where you want to install the provider and click Next.
4. Enter the IP address or hostname of your LogonBox server. If you don't have a signed certificate, you can choose to allow unsigned certificates.
5. Paste in the Registration Key.
6. Click Next and click Install to start the file copy.
7. Click Finish to complete the installation.
Altering the Credential Provider Text Prompts
You can alter the text that users will see on their login screens.
In your LogonBox server, go back to Authentication Flows -> Authentication Options -> Credential Provider. Here, you have options to change the Other User Text or LogonBox VPN connection.
As you have entered the Registration Key in the client, we recommend you turn on the Enforce API Security option and Apply the changes.
Other Options
You can opt to allow a networkless login from Authentication Flows -> Authentication Options -> Windows Login. If you are using Desktop MFA, you can log in to Windows with only a username/password if the LogonBox server is unavailable.
Example - Logging In
With the provider installed, you can log in to the Windows machine with your LogonBox credentials. See below:
Silent Install Options
You can also install the LogonBox Credentials Provider using the command line. This allows you to install the provider via a group policy update. To install the provider, you must specify the LogonBox hostname.
Note: You must have admin privileges for this.
For the EXE file
LogonBox+Credential+Provider.msi /qb LOGONBOX_URL=<hostname> REGISTRATION_KEY=<key>
Replace <hostname> with your LogonBox server's hostname or IP i.e. test.logonbox.com (Note that this is a host, not a URL as the parameter seems to imply).
Replace <key> with the registration key.
You can find additional command line options by running the EXE file with the /h switch like this: LogonBox+Credential+Provider.exe /h.
For the MSI file
LogonBox+Credential+Provider.msi /qb LOGONBOX_URL=<hostname> REGISTRATION_KEY=<key>
Replace <hostname> with your LogonBox server's hostname or IP i.e. test.logonbox.com. (Note that this is a host, not a URL as the parameter seems to imply).
Replace <key> with the registration key.
You can find additional command line options by running the MSI file with the /? switch like this: LogonBox+Credential+Provider.msi /?.
Creating a Transforms File for the MSI file
For silent installs via a GPO, you need a transforms file (MST) to pass the LOGONBOX_URL parameter. Here is an example using the tool called Orca:
1. Run Orca and go to File -> Open and open the LogonBox Credentials Provider MSI file.
2. Select the Transform -> New Transform menu.
3. Select the Property table.
4. Right-click in the main window, select Add Row, and enter the following:
- For Property, enter the
LOGONBOX_URL. - For Value, enter the
<hostname>.
Replace <hostname> with your LogonBox server's hostname.
5. Right-click in the main window, select Add Row, and enter the following:
- For Property, add the
REGISTRATION_KEY. - For Value, add the
<key>
Replace <key> with your LogonBox server's registration key.
6. Click Transform -> Generate Transform and save your MST file which can be used in a GPO.
Alternatively, you can select File -> Save Transformed As and write a new version of the MSI with this transform applied.
