BYOD portals
The BYOD portals page manages self-service onboarding portals. Users open a portal, sign in with their company account, and get a personal Wi-Fi certificate and network profile for each device they bring. Administrators use this page to create portals, choose the directory users sign in with, and set the secure network that devices are set up for.
What this page shows
Section titled “What this page shows”BYOD › BYOD portals lists the tenant’s BYOD portals in a table. Select a row to open the portal editor.
Each portal has a public address of the form:
https://<airgate-host>/byod/<tenant-slug>/<portal-slug>For example https://nac.contoso.com/byod/contoso/staff. Point the captive portal of the onboarding SSID (and your users) at this address. A disabled portal answers it with 404.
Fields and columns
Section titled “Fields and columns”Portal list
Section titled “Portal list”| Column | Meaning |
|---|---|
| Portal | The portal name, with its public address below. |
| Status | Live or Disabled. |
| Sign-in | The sign-in method, with the directory name below. |
| Wi-Fi network | The SSID devices are set up for. |
| Devices / user | How many devices one user may onboard. |
| Active devices | Devices onboarded through the portal that are still active. |
Portal editor
Section titled “Portal editor”The editor has five sections: General, Sign-in, Devices & Wi-Fi, Branding and Terms.
General
| Field | Meaning |
|---|---|
| Name | Required. Fills the slug while you type a new portal’s name. |
| Slug | Required. Part of the portal address. Lower-case. |
| Description | Optional. |
| Enabled toggle | Enabled: users can onboard devices or Disabled: the portal address returns 404. On by default. |
| Portal address | The public address, with a copy button. |
Sign-in
| Field | Meaning |
|---|---|
| Sign-in method | Microsoft sign-in (Entra ID) (default) or Username and password. |
| Directory | Required. For Microsoft sign-in: a Microsoft Entra ID directory with an app registration and client secret. For user name and password: Active Directory, LDAP, Entra ID or local users. Guest, Wi-Fi pass, endpoint and similar sources are not offered. |
| Redirect URI | Shown for Microsoft sign-in: <portal address>/callback. Add it to the app registration in the Entra admin center under App registrations › your app › Authentication › Add a platform › Web. Scopes used: openid, profile, email. |
| Allowed groups | Group names, or Entra group object IDs. Empty lets every user of the directory onboard devices. |
Devices & Wi-Fi
| Field | Meaning |
|---|---|
| Wi-Fi network (SSID) | Required. The secure network devices are set up for, for example Corp-WiFi. |
| RADIUS server name | The server name devices validate. Empty uses the EAP server certificate name, which the field hint shows. |
| Devices per user | Required. 1 to 100. Default 3. |
| Certificate validity (days) | Required. 1 to 1825. Default 365. |
| Platforms | The device types the portal offers, all on by default: iPhone, iPad, Mac (configuration profile, .mobileconfig), Windows (zip with a PowerShell installer), Android (certificate file and guided steps), Chromebook (ONC file), Linux (NetworkManager script) and Other (certificate file and manual steps). |
The device key is created on the server and delivered once over HTTPS through a single-use link that is valid for 10 minutes.
Branding
| Field | Meaning |
|---|---|
| Browser title, Heading, Message | Page texts. Default heading Connect your device to Wi-Fi. |
| Logo | PNG, JPEG, GIF, WebP or SVG, at most 256 KB. Remove clears it. |
| Primary, Background, Text | Colours. Default returns a colour to the built-in look. |
| Footer | Footer text. Every page ends with Powered by Airgate. |
Terms
| Field | Meaning |
|---|---|
| Terms toggle | Users must accept the terms before signing in. |
| Terms of use | The text users accept. |
Actions
Section titled “Actions”| Action | Where | What it does |
|---|---|---|
| New portal / Create a portal | Page header, empty list | Opens the editor for a new portal. |
| Select a row | Portal list | Opens the editor for that portal. |
| Save | Editor | Creates or updates the portal. |
| Preview | Row | Shows the portal’s landing page in a dialog. |
| Open | Row | Opens the portal address in a new browser tab. |
| Delete | Row | Asks for confirmation, then deletes the portal. Its address stops working. Devices onboarded through it keep their certificates and stay listed under BYOD devices. |
Permissions
Section titled “Permissions”- View:
onboard:read: Tenant Administrator, Network Administrator, Help Desk, Read-only Administrator and Platform Administrator. - Change:
onboard:write: Tenant Administrator, Network Administrator and Platform Administrator.
The Directory list is read from the authentication sources, which needs policy:read. Without it the list is empty.