UID - Manage UID WiFi

2023-03-30 09:49:58 UTC

This article describes how to create a UID WiFi network, assign, unassign, and block WiFi to users, set up IoT WiFi, and troubleshoot the most common issues with UID WiFi.

Note: Only Owner and Super Admin users have permission to edit the UID WiFi settings.

Create a UID WiFi network

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 installing the UID Agent application on your UniFi OS Console.

If the automatic deployment is disabled, configure UID WiFi manually:

  1. Select the site from the drop-down field at the top-left corner of the screen to access its dashboard. 
  2. Select One-click WiFi in the Services section.
  3. Set the WiFi network’s name (Workspace SSID) along with other UID WiFi settings.

    Note: These can be edited later in the workspace’s Settings > Advanced > WiFi menu.

  4. Set up a VLAN network by clicking the drop-down window to display the existing VLANs in the network application, or click New VLAN to create a new one.

Note: Ipv6 for Network is not supported at the moment.

Edit the WiFi settings

To edit your UID WiFi:

  1. Select One-click WiFi in the Services section, then select the Host Devices tab on the left-hand menu.
  2. Click on the host device to view and edit the details on its properties panel:
    1. In the Host Device tab, you will find information related to the host device, such as Status, MAC address, IP address, UID Agent version, and others.
    2. In the UID WiFi tab, you can enable or disable UID WiFi and edit VLAN.


From the UID Agent dashboard, go to Settings > Advanced and click on the WiFi tab to access and configure the following settings:

  • Workspace SSID: Can be modified but cannot be left empty.
  • WiFi Life Time: This establishes a time limit for your WiFi usage. Once surpassed, your WiFi will automatically disconnect. It is set to One day by default.
  • Hide SSID: This setting is disabled by default. When enabled, users will be unable to see your WiFi in their available network list.
  • Allow All Users to Connect by Default: This is enabled by default but can be disabled.
  • Require Location Detection When Connecting to WiFi: This is disabled by default. When enabled, only users within a certain proximity of the workspace can connect to its WiFi.
  • Location Detection Range: Set the location detection range anywhere between 500 and 2,000 meters.


Assign and unassign UID WiFi to users

To assign UID WiFi to a user:

  1. Select One-Click WiFi in the Services section.
  2. Open the Assignment tab on the left-hand menu, or click the Assign User shortcut in the upper-right in the WiFi Dashboard tab.

  3. Select the users or groups you would like to assign the WiFi to and click OK.


To unassign a user from the UID WiFi:

  1. Open the Assignment tab on the left-hand menu.
  2. Select the groups and/or users to unassign:
    1. To delete multiple groups and users, select the group(s) or user(s) that you would like to remove and click Remove.
    2. To unassign a single user, hover over the user, click Remove, then click Confirm.


Block users from accessing UID WiFi

To block a user from accessing UID WiFi:

  1. Select One-Click WiFi in the Services section.
  2. Open the Assignment tab on the left-hand menu and select the Blocked tab.
  3. Click Block User on the top-right corner.
  4. Select users that you would like to block and click Add.


Disable UID WiFi

To disable UID WiFi:

  1. Go to Site > Dashboard > One-Click WiFi > Host Devices.
  2. Hover over the UniFi OS Console and select Disable UID WiFi.

Note: Until you disable the UID WiFi on this page, you will not be able to disable it on the UniFi Network application.


Manage IoT WiFi Devices

In order to use IoT WiFi, please ensure the devices have met these firmware requirements:

  • UniFi AP: Version 5.71 or higher
  • UID Agent: Version 1.42.3+1545 or higher
  • UDM Base: Version1.9.3 or higher

Like UID WiFi, IoT WiFi is enabled automatically after installing the UID Agent application. Auto-deployment is enabled by default, and each host device has deployed UID WiFi and IoT WiFi. If the auto-deployment setting is disabled, IoT WiFi will be enabled when an Admin manually sets up UID WiFi.

To manage IoT devices from the web:

  1. Go to the UID site dashboard and click the One-Click WiFi icon. 
  2. Click the IoT WiFi Devices on the left menu.

From this page, you can Add new IoT devices, enable, disable, delete, and edit Device Name and Device Type of existing IoT devices.

To add a new device in the UI mobile app:

  1. Open the UI app and tap the icon on the bottom right of the WiFi icon, then select Add new IoT device.
  2. Enter the SSID and Password on the IoT device to connect IoT WiFi (this process can take a minute).

To manage IoT WiFi in the UID Manager mobile app:

  1. Open the UID app and click IoT WiFi to enter the IoT WiFi Devices interface.
  2. To add a new IoT Device, click the + button on the top-right corner. Enter the SSID and Password on the IoT device to connect IoT WiFi (this process can take a minute).
  3. You can tap on a device in the list of devices to edit the device name, enable, disable, or delete the device.

Troubleshooting UID WiFi connection issues

Unable to connect to UID WiFi

Issues with UID WiFi connection may include:

  • UID WiFi keeps disconnecting or is unable to connect
  • UID WiFi shows as Connected but there is no internet connection
  • The UID WiFi network doesn't show up on the WiFi list on your desktop or mobile device

If you're having any of the issues above, make sure that:

  1. The Dream Machine Pro (skip this step if you’re using a Dream Machine) is connected to the switch and the UAP, and that all devices are adopted in the UniFi Network application:
    1. Go to the application's Devices section to confirm the status of the devices is Connected.


  2. The UniFi OS Console and the UID Agent application are online and connected:
    1. Go to the UID Admin Portal > select the site > One-click WiFi > Host Devices section and check if the console is online.
  3. The UID WiFi is assigned to the user and to the current site.


  4. An IP address is assigned after connecting to the UID WiFi:
    1. If there's no IP address assigned or not enough IPs assigned, go to the Network application and change the subnet the LAN settings in Settings > Networks > LAN > Advanced to disable Auto Scale Network, then find the subnet on Gateway IP/Subnet.


  5. The user is listed in the Network application > Settings > Advanced Features > click on the RADIUS profile > RADIUS Users:
    1. If the user is not there, click Create New RADIUS User and follow the instructions on-screen.


  6. The UID WiFi password on the user's UI mobile/desktop application is the same as the password in the RADIUS Users settings:
    1. Click on the user to see its password and other settings.


If you've double-checked all steps above and the user is still having issues connecting to UID WiFi:

  1. Download the support file by going to Settings > Advanced > Download Support File.
  2. Reach out to uid.support@ui.com for further assistance.

If your issue is resolved, please submit your feedback on the UI mobile app by clicking on your account initials/image icon > Feedback or on the UI Desktop application by clicking on the settings icon > Give Feedback. 

Delete UID WiFi Manually

To delete UID WiFi, follow the steps below.

1. SSH into your UniFi OS Console.

ssh root@UDM_IP

2. Obtain the WiFi list with the curl command.

curl http://localhost:8081/v2/api/site/default/uid/wlan |jq '.[] | {_id:._id,name:.name}'

3. Copy the command below and replace {wifi_id} with the ID of the WiFi you wish to delete.

curl -X DELETE http://localhost:8081/v2/api/site/default/uid/wlan/{wifi_id}


Related articles

Intro to Networking - How to establish a connection using SSH

Was this article helpful?
11 out of 22 found this helpful