Upgrading to UID Enterprise
UID Enterprise is our subscription service that allows you to centrally manage user permissions across all UniFi Sites. If you are looking for a free UniFi Identity or UniFi Fabric management solution, see here.
| Update your UniFi OS and UID Enterprise Agent to the latest versions for the newest features and optimal performance. |
Requirements
Before adding a UniFi Console to UID Enterprise, ensure that you have met the following requirements:
- You are the UniFi OS Owner.
- Your UniFi Console model is listed in the table below.
| Model | One-Click WiFi | One-Click VPN | Door Access | Camera Sharing | EV Station | AD/LDAP Integration |
File Access |
| Dream Machine Base (UDM-Base) | ✓ | ✓ | ✗ | ✗ | ✗ | ✓ | ✗ |
| Dream Machine Pro (UDM-Pro) | ✓ (Requires UAP) | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ |
| Dream Machine SE (UDM-SE) | ✓ (Requires UAP) | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ |
| Dream Machine Pro Max (UDM-Pro-Max)1 | ✓ (Requires UAP) | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ |
| Dream Wall (UDW) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ |
| Network Video Recorder (UNVR) | ✗ | ✗ | ✓ | ✓ | ✗ | ✓ | ✗ |
| Network Video Recorder Pro (UNVR Pro) | ✗ | ✗ | ✓ | ✓ | ✗ | ✓ | ✗ |
| Enterprise Network Video Recorder (ENVR) | ✗ | ✗ | ✓ | ✓ | ✗ | ✓ | ✗ |
| CloudKey Gen2 Plus (UCKP) | ✓ (Requires a Gateway) | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ |
| CloudKey Gen2 (UCK) | ✓ (Requires a Gateway) | ✓ | ✗ | ✗ | ✗ | ✓ | ✗ |
| CloudKey Enterprise (UCK-Enterprise) | ✓ (Requires a Gateway) | ✓ | ✗ | ✗ | ✗ | ✓ | ✗ |
| Cloud Gateway Max (UCG-Max)2 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ |
| Cloud Gateway Fiber (UCG-Fiber) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ |
| Cloud Gateway Industrial (UCG-Industrial) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ |
| Cloud Gateway Ultra (UCG-Ultra) | ✓ | ✓ | ✗ | ✗ | ✗ | ✓ | ✗ |
| Enterprise Fortress Gateway (EFG)3 | ✓ | ✓ | ✗ | ✗ | ✗ | ✓ | ✗ |
| UNAS Pro 8 (UNAS-Pro-8)4 | ✗ | ✗ | ✗ | ✗ | ✗ | ✓ | ✓ |
| UNAS Pro (UNAS-Pro) | ✗ | ✗ | ✗ | ✗ | ✗ | ✓ | ✓ |
| UNAS Pro 4 (UNAS-Pro-4) | ✗ | ✗ | ✗ | ✗ | ✗ | ✓ | ✓ |
| UNAS 4 (UNAS-4) | ✗ | ✗ | ✗ | ✗ | ✗ | ✓ | ✓ |
| UNAS 2 (UNAS-2)4 | ✗ | ✗ | ✗ | ✗ | ✗ | ✓ | ✓ |
- Requires Dream Machine Pro Max 4.0.3 (EA) or later.
- Requires UniFi OS 4.1 or later.
- Requires UniFi OS 4.0 or later.
- Requires UniFi OS 5.0.5 or later.
Data and Configuration Migration
| Important: We strongly recommend backing up your UniFi Console before upgrading to UID Enterprise. |
-
NFC Card and PIN: Users’ NFC cards and PINs can be imported to UID Enterprise when the following requirements are met:
- You have never added a UniFi Console with NFC cards or PINs registered to your current workspace. If you have multiple consoles to add, only the NFC cards and PINs registered in the first console can be imported to your workspace. Even if you remove the first console from your workspace, the NFC cards and PINs of the remaining consoles still need to be re-registered.
- You have imported UniFi OS users to UID Enterprise.
-
Mobile Access, One-Click WiFi, One-Click VPN, EV Station, and Camera: Users can access these resources assigned to them using their UID Enterprise apps when the following requirements are met:
- You have imported UniFi OS users to UID Enterprise and sent invitation emails to them.
- Your users have activated their UID Enterprise accounts.
Add a Console to Your UID Enterprise Workspace
After you have activated your UID Enterprise workspace, you can add multiple UniFi Consoles to it.
- A site or workspace can include multiple UniFi Consoles, but each UniFi Console can be added to only one site or workspace.
- You must be the Workspace Owner, a Super Admin, or have a custom role with permission to edit UniFi Consoles.
- Go to UID Enterprise Manager > Settings > UniFi Consoles > Consoles > Add Console.
- Select a site, set the expiration period, review the important notice, then click Continue.
- Verify your account.
- Follow the on-screen instructions to connect to the console through SSH, update the UID Enterprise Agent, and run the provided command. The command expires after 10 minutes.
Understand Account Types
This table outlines each account type and its respective permission(s). Refer to this article for more information on connecting to UniFi Site Manager or Local Site Manager.
| Account | Description | Purpose |
| UI Account |
|
|
| Local Credentials |
|
Access Local Site Manager |
| UID Enterprise Account |
|
Access UniFi Site Manager by redirecting from UID Enterprise Workspace |
FAQ
I have deactivated UID Enterprise on a UniFi Console. Can I reactivate it on the console?
Yes. You can reactivate UID Enterprise on the UniFi Console in two ways: by creating a new UID Enterprise workspace on the console or by adding the console to an existing workspace. See this FAQ for details.
Can I use UID Enterprise on UniFi OS Server?
No. UID Enterprise can only be installed on supported UniFi Consoles. Learn more about UniFi OS Server
Can I use UID Enterprise on Official UniFi Hosting?
No. UID Enterprise can only be installed on supported UniFi Consoles. Learn more about Official UniFi Hosting
Introducing UniFi OrganizationsBackups and Migration in UniFiUniFi UID Enterprise - Import Users from Google Workspace, Microsoft 365, CSV File, or UniFi OS UID Enterprise and UID Enterprise Endpoints UID Enterprise - Account and MFA UID Enterprise - Manage Workspace Settings UniFi Remote Management via Site Manager UID Enterprise - Downgrade UID Enterprise to UniFi Identity Self-Hosting UniFiGetting Started with Official UniFi Hosting