Getting Started
Overview
This guide covers deploying the Britive Access Broker on a Windows host and registering target Windows servers as resources in Britive Resource Manager. Once complete, the broker is ready for all Windows use cases: temporary local user accounts and remote local group membership for JIT RDP access.
The broker runs as a Windows service and communicates outbound to Britive over HTTPS — no inbound ports are required.
Before You Begin
- A Britive tenant with administrator access
- A Windows Server 2019 or 2022 host to run the broker
- Java 21 (OpenJDK) on the broker host
- A broker pool token from Resource Manager → Broker Pools → New Pool in the Britive console
- Outbound HTTPS (port 443) from the broker host to Britive
- PowerShell remoting (WinRM) enabled on target servers the broker will manage
Broker Service Account
The broker runs as a Windows service. We recommend using a Group Managed Service Account (gMSA) to avoid managing service account passwords manually.
The gMSA needs the following rights on target servers (applied via GPO or Local Security Policy):
| Right | GPO setting |
|---|---|
| Allow log on through Remote Desktop Services | SeRemoteInteractiveLogonRight |
| Access this computer from the network | SeNetworkLogonRight |
| Remote management (WinRM) | Remote Management Users local group membership |
Apply via Group Policy Management Console → Computer Configuration → Policies → Windows Settings → Security Settings → Local Policies → User Rights Assignment, then add the gMSA (DOMAIN\svc-britive$).
Install the Broker
Download the broker installer
Obtain the broker download link from your Britive tenant under Admin → Access Broker → Download Agent. Download the .exe or .msi installer to the broker host.
Install Java 21
Download OpenJDK 21 from adoptium.net and install. Verify:
java --versionRun the installer
Execute the broker installer. Accept the default installation path:
C:\Program Files (x86)\Britive Inc\Britive Broker\Configure the broker
Open broker-config.yml in the install directory and set your broker pool token:
broker_pool_token: "<your-broker-pool-token>"Configure the service account
Set the Windows service to run as the gMSA. No password is needed for gMSAs:
sc.exe config "BritiveBroker" obj= "CONTOSO\svc-britive$"Alternatively, open Services (services.msc) → right-click Britive Broker → Properties → Log On tab → enter CONTOSO\svc-britive$ with a blank password.
Grant the gMSA full control of the install directory
The broker downloads scripts to its install directory at runtime:
$installDir = "C:\Program Files (x86)\Britive Inc\Britive Broker"
$acl = Get-Acl $installDir
$rule = New-Object System.Security.AccessControl.FileSystemAccessRule(
"CONTOSO\svc-britive$", "FullControl",
"ContainerInherit,ObjectInherit", "None", "Allow"
)
$acl.AddAccessRule($rule)
Set-Acl -Path $installDir -AclObject $aclStart the service
Start-Service -Name "BritiveBroker"
Get-Service -Name "BritiveBroker"
# Status should show: RunningEnable WinRM on Target Servers
The broker manages Windows servers via PowerShell remoting (WinRM). Run on each target server as a local administrator:
Enable-PSRemoting -Force
# Verify from the broker host
Test-WSMan -ComputerName "target-server.contoso.com"In a domain environment with the broker gMSA having remote management rights, Kerberos authentication is used automatically — no additional credential configuration is needed.
Register Windows Servers as Resources
Create a resource type
Go to Resource Manager → Resource Types → New Resource Type.
| Field | Value |
|---|---|
| Name | WindowsServer |
| Description | Windows RDP server |
Add parameters:
| Parameter | Type | Required |
|---|---|---|
hostname | string | Yes |
port | string | Yes |
Register a server
Go to Resource Manager → Resources → Add Resource.
| Field | Value |
|---|---|
| Name | prod-win-01 |
| Resource Type | WindowsServer |
| hostname | prod-win-01.contoso.com |
| port | 5985 |
Under Broker Pools, associate the pool connected to this server.
Verify
# On the broker host: confirm the service is running
Get-Service -Name "BritiveBroker"
# Check the Windows event log for broker startup
Get-EventLog -LogName Application -Source "BritiveBroker" -Newest 10In the Britive console:
Check broker pool status
Go to Resource Manager → Broker Pools — broker status should be Connected.
Check registered resources
Go to Resource Manager → Resources — registered servers should appear.
Troubleshoot
| Symptom | Cause | Fix |
|---|---|---|
| Service fails to start with gMSA | Computer account not in PrincipalsAllowedToRetrieveManagedPassword | Add broker host to the gMSA’s allowed retrieval list |
| Broker shows Disconnected | Outbound HTTPS blocked | Open port 443 from broker host to *.britive-app.com |
Access denied on install directory | gMSA missing Full Control | Re-run the ACL script above |
WinRM cannot complete the operation | WinRM not enabled on target | Run Enable-PSRemoting -Force on the target server |
| Broker pool token rejected | Stale or wrong token | Regenerate from Resource Manager → Broker Pools |
Next Steps
- Temporary Local User Access — create and delete temporary local accounts for JIT RDP
- Local Group Access — add users to local groups (e.g. Remote Desktop Users) for JIT RDP