UniFi Identity Enterprise - Activate UniFi Identity Enterprise

Activate UniFi Identity Enterprise

Requirements

Before activating UniFi Identity Enterprise, make sure that:

• You are the UniFi OS owner.
• Your email address has not registered for more than 3 workspaces. Otherwise, you need to transfer the UniFi Console’s ownership to another email address or add the console to an existing workspace.
• Your UniFi Console has not activated more than 3 workspaces.
• Your UniFi Console model meets the requirements shown in the table below. 

• Your UniFi Access devices and Identity Enterprise Agent meet their respective requirements.
• • UA Lite: v3.9.8.0 or later.
  • UA Pro: v2.3.178 or later.
  • UA Hub: v4.0.14.15 or later.
  • Identity Enterprise Agent: v1.54.6 or later.

Data and Configurations Migration

Activating Identity Enterprise running on v1.53.6 or earlier may result in the inability to synchronize your UniFi Access credentials and configurations with Identity Enterprise. It is strongly recommended to update your Identity Enterprise Agent to the latest version before activation to ensure smooth and seamless data synchronization.

Activate UniFi Identity Enterprise 

1. Go to your UniFi Site Manager and select a console.
2. Click the UniFi Identity Enterprise application after it is up-to-date.
3. Tick the "I agree to UniFi Identity’s Privacy Policy and End User License Agreement" checkbox.
4. Click Activate.
5. Select the UniFi OS users you want to migrate to UniFi Identity Enterprise and click Migrate Users.
6. Once your UniFi Identity Enterprise is activated, you will receive a notification via your UniFi mobile app. Open your UniFi mobile app and follow the instructions to start exploring One-Click WiFi, One-Click VPN, and other powerful features. If your console is UNVR or UNVR, the instructions will be pushed to your UniFi Protect mobile app. If you did not receive a push notification, please download the Identity Enterprise app from the hyperlink in the UniFi Identity Enterprise activation email and sign in with the temporary password.

Note: After activating UniFi Identity Enterprise, you need to import users from UniFi OS. Once users are imported, their credentials (PIN and NFC cards) will also be imported to UniFi Identity Enterprise.

Customize Workspace Domain

Once your UniFi Identity Enterprise is activated, the system will automatically generate a workspace domain. Your UniFi Identity Enterprise workspace users can access their workspaces via https://[your workspace domain].ui.com. To customize your workspace domain, please follow the steps below:

1. Sign in to your Identity Enterprise mobile app.
2. Tap Apply for your domain in your Identity Enterprise mobile app's dashboard.
3. Enter the workspace domain you would like to apply for, and tap Apply. You will be notified of the application result via email and Identity Enterprise mobile app notifications.

Add a Console to an Existing Workspace

After you have activated your UniFi Identity Enterprise workspace, you can add multiple UniFi Consoles to your workspace.

Notes

• A site or a workspace can include multiple UniFi Consoles. But a UniFi Console can only be added to one site or one workspace.
• To enable Door Access, One-Click VPN, One-Click WiFi, Directory Integration, and UC EV Station (EA) services, at least one UniFi Console must be added to your UniFi Identity Enterprise workspace.

Requirements

• UA Lite: v3.9.8.0 or later.
• UA Pro: v2.3.178 or later.
• UA Hub: v4.0.14.15 or later.
• Identity Enterprise Agent: v1.54.6 or later.

Add a Console to an Existing Workspace

1. Sign in to your Identity Enterprise Manager (https://[your workspace domain].ui.com/cloud).
2. Go to Settings > UniFi Console > Consoles and click the "+" icon.
3. Enter the token description and set the token validity period.
4. The services that can be set up are ticked by default.
5. Click Create and Verify your account with an MFA method.
6. Copy the generated security token.
7. Go to your UniFi Site Manager, select a console, and click Application in the left sidebar.
8. Select Identity Enterprise (UID) application.
9. Tick the "I agree to UniFi Identity Enterprise’s Privacy Policy and End User License Agreement" checkbox and click Add This Console to an Existing Workspace.
10. Paste the security token you just copied and select to add this console to an existing or new site. Please select a proper site. Otherwise, you will have to delete the console from UniFi Identity Enterprise and repeat the steps above to change a site.
11. Click Add.

Note: After activating UniFi Identity Enterprise, you need to import users from UniFi OS. Once users are imported, their credentials (PIN and NFC cards) will also be imported to UniFi Identity Enterprise if there are no credentials in your workspace.

Deactivate UniFi Identity Enterprise

Note: Only the UniFi Console owner can deactivate Identity Enterprise.

1. Go to your UniFi Site Manager and select the UniFi Console on which the Identity Enterprise is installed.
2. Go to Identity Enterprise > Manage and click Deactivate.
3. Confirm you want to deactivate Identity Enterprise and select whether to retain the users, services, and permissions locally on the console.
4. Click Deactivate.
5. Once deactivated, you can click Skip to finish or click Send Email Invitation to invite existing users to download UniFi Identity mobile apps and use the One-Click WiFi, One-Click VPN, Door Access, and EV Station features.