UID - Use UID

This article examines the key features of UID and demonstrates how a UID administrator can configure them. Upgrade your UniFi OS Console to its latest firmware version to access these features.

If you haven't set up your UID workspace and the UID Agent application, do both first by following the processes outlined in UID - Getting started.

• Set up Single Sign-on (SSO)
• Multi-factor authentication (MFA)
• Create security policies
• Manage your workspace users
• Set up and manage UID Access
• Set up and manage UID WiFi
• Set up and manage UID VPN
• Manage your Help Desk
• Manage the UID host device
• Update your applications and devices

Multi-factor authentication (MFA)

Multi-factor authentication (MFA) is an added layer of security used to verify an end user's identity when they sign in. UID admins have the option to configure authentication methods for all workspace users or allow users to set up their own MFA methods. 

Read more about MFA in our multi-factor authentication article.

Create security policies

UID allows admins to create sign-in policies that enforce group or role-specific credential requirements. 

To create a new policy:

1. Log in to UID with an Owner or Super Admin account.
2. Go to the Security > Security Policy page.
3. Expand either the UID Sign-On Policy or Password Policy section and click Add. 

Note: Every policy must include at least one rule to be applied. If no custom policies exist, default policy terms will apply to all users unless they are edited or deleted.

• In the UID Sign-On Policy section, you can define when a user’s login attempt will be allowed or denied.
• In the Password Policy section, you can set password requirements and expiration timeframes.

Created rules and policies are listed in the Security Policy section. You can edit or delete them any time from here.

Manage your workspace users

UID administrators can edit each workspace user’s role and access, or delete their profile entirely. 

Change a user's status: in the Users section by specifying a user, then selecting one of the statuses from the dropdown in the bottom-right corner of the page. 

Learn more about adding new users to your workspace and changing their status in the UID - Manage workspace users article.

Administrators can use default UID user roles, create custom ones, or organize users into groups to simplify the process of applying security policies or making bulk user changes. 

Learn more about user roles in our UID - User Roles and User Groups article.

To easily find users and visualize their position within your company, either:

• Click the rocket icon in the upper-right corner of your main dashboard to access the Directory section, then click the Org Chart tab, or. 
• Log in to UID with an admin account, then go to Users > Org Chart.

Users must have at least one supervisor associated with their profile to be viewable in the organization chart.

Set up and manage UID Access

You can manage your UniFi Access system with the UID application by updating your UniFi OS to UID. To use UID Access, you must first set up UID and install the UID Agent application. 

If you haven’t yet, please do so by following the processes outlined in our UID - Getting started article. 

After you’ve completed this initial configuration, you will see a new door icon in the far-left sidebar menu of your UID Manager Portal. Click the icon to open the UID Access section and manage all aspects of UID Access including, but not limited to:

• Setting up sites, floors, and doors
• Door access policy creation
• Door unlock scheduling
• Door guard features
• UID Visitor features
• Access logging

Read more about UID Access in our Manage UID Access article.

Set up and manage UID WiFi

Note: A Dream Machine (UDM) or Dream Machine Pro (UDM Pro), and at least one UniFi Access Point (UAP) is required to create a UID WiFi network.

UID WiFi is automatically deployed after setting up the UID Agent application on your UniFi OS Console. If automatic deployment is disabled, the following must be done manually.

For more information on the UID WiFi configuration, see UID - Manage UID WiFi.

Set up and manage UID VPN

To create a UID VPN, configure a port forwarding rule in the UniFi Network application, then complete the VPN configuration in UID by selecting One-click VPN. 

To learn more about UID VPN configuration,  see our UID - Manage UID VPN article.

Manage your Help Desk

UID administrators can configure their workspace’s internal support process by determining ticket types and assignees for each request type.

To configure a new ticket type:

1. Log into the UID workspace with an admin role, go to Help Desk > Settings and click Add Ticket Type in the upper right corner.

2. You can configure the ticket type, including: an icon to represent it, if it will be available for all sites or only one, who will review the ticket and who will resolve the ticket. The latter can be either a specific user, role or user group.

3. If Assigned to only one assignee is checked, the ticket will be assigned to one of the users with the appointed role or group selected in the Who will handle this ticket dropdown.

To deactivate and delete a ticket type:

1. Log into the UID workspace with an admin role and go to Help Desk > Settings and either hover over one of the ticket types to deactivate, or select it and change its status to Inactive. 

2. You can delete a ticket type once it’s inactive.

Help Desk ticket permissions

Users can perform different ticket actions depending on their role. Owners and Super Admins can delete, transfer and change statuses on all tickets, while the Site Admin and regular User will have certain limitations.

		Owner	Super Admin	Site Admin	User
Change Ticket Status	All Tickets
	Tickets submitted by you
	Tickets assigned to you
	Tickets from your managed site				N/A
Transfer Tickets	All Tickets
	Tickets submitted by you
	Tickets assigned to you
	Tickets from your managed site				N/A
Delete Tickets	All Tickets
	Tickets submitted by you
	Tickets assigned to you
	Tickets from your managed site				N/A

Manage the UID host device

Your UniFi OS Consoles can be managed within UID Cloud > Settings > UniFi OS Consoles. Select a UniFi OS Console to see its details and perform management tasks such as:

• Adding, editing and deleting administrators. Note that: 
  • Users with the following roles on UID will be made Super Admins on the UniFi OS Console: Owner, Super Admin, and the Site Admin where the UniFi OS Console is located.
  • If the UniFi OS Console has users with Super Admin or Limited Admin roles before installing UID, these users will be assigned the Host Device Admin role with corresponding UniFi application privileges after they are imported into UID. These Host Device admins can be edited and deleted in this section.
  • Any user given UID Admin roles will be added as a Super Admin in the UniFi OS Console and cannot be edited or removed from the UniFi OS Console Settings.
• Upgrading the UniFi OS Console
• Launching the UniFi OS Portal
• Deleting the Host Device. 
  • Note: Deleting a host device will also delete UID Access, UID WiFi, UID VPN for that site.

Update your applications and devices

You can stay effortlessly up-to-date by enabling the auto update feature in the UniFi OS Settings > Updates > Auto Update for both your UniFi OS Console and its Applications.

To manually update the UID application:

1. Check within UID Sites Settings > Host Devices. If an update is available, there will be a clickable next to the UniFi OS Console’s agent version.

2. Click on the icon to begin the update process.

To manually update the UI desktop application:

1. Click on the UI icon on the top of your screen and go to Settings > Check for Updates.

2. If there is a newer version available, you can update.

To manually update any of our mobile apps you can configure your mobile’s settings to auto-update or check the App Store or Google Play Store apps to check if an update is available.

To manually update the UID Access devices:

1. Go to the UID Site > UID Access > Elements and check if any device has an update icon on the firmware column.

2. You may upgrade each device one by one, by clicking on the update icon on its row, or update all devices by clicking the update icon next to the firmware column header.

Delete UID

You can uninstall the UID Agent application by deleting your Host Device through UID Manager Portal > UniFi OS Consoles > Details > Select Device > Delete Device.

To remove UID:

1. Log into the workspace owner's account and go to the UID Manager Portal.

2. Go to Settings > UniFi OS Consoles > Details.

3. Select the host device that needs to be deleted and enter the host device details page.

4. Click the Delete button on the bottom of the page.

Note that once you have deleted the UniFi OS Console in UID, the below information will also be deleted:

• UID WiFi
• UID VPN
• UniFi Access device data
• All the users (except the user) with UID accounts in the UniFi OS Console
• All user groups will be consolidated into one top-level group renamed as the hostname

UID Agent will restart automatically, at which point you will be able to use UniFi Access again.

Because UID WiFI uses the quota of SSID and RADIUS, if you want to use the previous WiFi/VPN after deleting UID, you may need to recreate the WiFi and add RADIUS users again. All UniFi Access devices will be reverted back to unconfigured status after the host device is deleted. You will need to readopt the Access devices.