Guest portal
The Guest portal page manages the captive portals that guests land on when a network device redirects them: log in with an existing account, register for one, or accept the terms of use. It also manages the skins that set the look of the portal pages.
What this page shows
Section titled “What this page shows”Guests › Guest portal has two tabs: Portals (with a count) and Skins.
Portals tab
Section titled “Portals tab”Each portal appears as a card or as a table row. The Cards / Table switch on the right sets the view; your browser remembers the choice.
The toolbar filters the portals:
| Filter | Meaning |
|---|---|
| Name, slug, URL, role… | Matches the portal name, slug, description, URL, role or authentication service. |
| Portal type | All types, or one of the portal types in use, with a count. |
| Clear filters | Resets the filters. |
Each tenant starts with one portal, Guest Wi-Fi (slug guest), a disabled self-registration portal.
Portal URL
Section titled “Portal URL”Every portal has a public URL of the form:
https://<airgate-host>/portal/<tenant-slug>/<portal-slug>For example https://nac.contoso.com/portal/contoso/lobby. Configure this URL as the captive-portal or redirect URL on the network device. A disabled portal answers this URL with a “not found” page.
Skins tab
Section titled “Skins tab”Lists Custom skins and Built-in skins as cards. A skin is the look of a portal page: colours, logo, background image, CSS and header and footer HTML. A portal’s own colours and logo override its skin’s. The built-in skins are Classic (the default), Airowire, Minimal, Hospitality and Dark; they are read-only.
Fields and columns
Section titled “Fields and columns”Portal card
Section titled “Portal card”| Field | Meaning |
|---|---|
Name and /slug |
The portal name and its URL slug. |
| Status | Enabled or Disabled. |
| Badges | Portal type, login model (MAC caching + CoA or Web login), the authentication service if set, MAC trust off or Signed redirect. |
| URL | The public URL, with copy and open buttons (open only while enabled). |
| Role | Role of accounts created by the portal; [Guest] when not set. |
| Account lifetime | The lifetime of accounts the portal creates, or Per account for guest-login portals. |
| MAC caching | Days a device stays authorized, Until expiry (≤ 30d), or n/a (web login). |
| Vendor | The network device vendor handling. |
| Terms | Must accept, Optional or None. |
| Accounts | Number of guest accounts linked to the portal; links to Guest accounts filtered by the portal. |
Portal table
Section titled “Portal table”| Column | Meaning |
|---|---|
| Portal | Name and slug. |
| Type | Self-registration, Guest login or Accept terms. |
| Status | Enabled or Disabled. |
| Login model | MAC caching + CoA or Web login, with the vendor below. |
| Approval | Not in use; shows —. |
| Role | The portal’s role. |
| Lifetime | Account lifetime, or Per account. |
| Accounts | Linked accounts, with a link to Guest accounts. |
| Updated | Time since the last change. |
Portal editor
Section titled “Portal editor”Select a portal (or New portal) to open the editor. Sections run down the left; an approximate preview of the landing page and the public URL are on the right.
General
| Field | Meaning |
|---|---|
| Portal name | Required. Up to 128 characters. |
| URL slug | Required. Lower-case letters, digits and -, up to 63 characters, starting with a letter or digit. sponsor, static, assets and api are reserved. Filled from the name for a new portal. |
| Description | Optional. |
| Enabled toggle | Enabled: the portal answers guests or Disabled: the public URL returns 404 (preview links still work). |
| Portal type | Self-registration: visitors fill in a form and get an account. Guest login: existing accounts (operator-created, bulk, sponsored) log in with user name and password. Accept terms: click-through; a password-less account per device once the terms are accepted. |
| Role | Role of the accounts and devices the portal creates. Default [Guest]. |
| Account lifetime | 1 hour to 30 days, No expiry or Custom… minutes (up to 5,256,000). Default 1 day. |
| When an account expires | Stop authenticating (0) to Delete and logout (4). Default Delete and logout (4). |
| Authentication service | Optional WEBAUTH or APPLICATION service; logins then run through its sources, role mapping and enforcement. None ([Guest User Repository] only) by default. Listing services needs policy:read. |
| After login, go to | An http(s) URL. Empty sends guests to the page they originally requested. |
Branding
| Field | Meaning |
|---|---|
| Skin | A built-in or custom skin. Edit skins opens the Skins tab. |
| Browser title, Heading, Message | Page texts. Defaults: Guest Wi-Fi, Welcome, Register to get online. |
| Button label | Empty uses the default for the portal type. |
| Footer | A footer line, for example a help-desk number. |
| Primary (buttons), Background, Text | Colours as #rgb or #rrggbb. Empty uses the skin’s colours. |
| Logo | PNG, JPEG, GIF, WebP or SVG, up to 256 KiB encoded. Embedded in the page; overrides the skin’s logo. |
Form fields (self-registration portals)
The default form is Full name (required), e-mail, mobile phone and company. Customize the form lets you edit, reorder and remove fields and + Add field… adds a preset (Full name, E-mail, Mobile phone, Company, Host name, Host e-mail, Reason for visit) or a custom field, up to 30. Fields named name, email, phone, company, sponsor_name and sponsor_email fill the account; any other name becomes a custom field (GuestUser:<name>). The field the user name derives from is always required.
| Field | Meaning |
|---|---|
| Name | Lower-case letters, digits and _, starting with a letter. Unique. |
| Label, Placeholder | Shown to the visitor. |
| Type | text, email, tel, select, checkbox or textarea. A select needs Options. |
| Max length | 0 to 1024; 0 = default. |
| Required | Whether the visitor must fill it in. |
Terms of use
| Field | Meaning |
|---|---|
| Terms toggle | Guests must accept the terms to log in / register. Always required on accept-terms portals. |
| Terms of use | Plain text up to 64 KiB, shown in a scroll box with an I accept checkbox. Restore default text restores the default. |
Login & network
| Field | Meaning |
|---|---|
| Login model | MAC caching + CoA: the device MAC is cached and a CoA re-runs MAC authentication, which now matches the guest service (Aruba switches, Cisco, Arista, Extreme). Web login: the page posts the user name and a one-time password to the network device’s login URL, or redirects to the vendor grant URL (Aruba controllers and Instant, Meraki, Ruckus, Fortinet, Mist). |
| MAC caching | Days a device stays authorized after login, 0 to 3650. 0 = until the account expires (at most 30 days). Never beyond the account expiry. Default 1. |
| Post-login CoA | Reauthenticate (role change, default), Bounce port (wired VLAN change) or Disconnect (wireless VLAN change). |
| Success page delay | 0 to 300 seconds to wait before continuing (wired bounce flows). |
| Redirect MAC trust | Session (default): the redirect MAC must have RADIUS activity in this tenant in the last 15 minutes. Signed: also require a valid Aruba redirect-URL hash. Off (insecure): trust the redirect MAC. An untrusted MAC is never cached, bound to the account or sent a CoA. |
| URL hash key | The url-hash-key of the Aruba captive-portal profile. Required for Signed, which works with the vendors Aruba, Aruba switch and Auto-detect only. Stored encrypted. |
| Vendor handling | How Airgate reads the redirect and completes the login. See the vendor list below. |
| Grant duration (Meraki / Mist) | 0 to 525,600 minutes; 0 = the remaining account lifetime. |
| Mist WLAN API secret | Signs the Mist authorize URL. Stored encrypted. |
| Login URL, Method, Username field, Password field, Extra form fields | The generic web-login target, shown for Generic (or web login with Auto-detect). The login URL may use {nad_ip} and {login_host}; extra field values may use {original_url}, {mac} and {ip}. |
| Allowed login hosts | Extra hosts the portal may post credentials to: exact host, *.suffix, IP or CIDR, for example 10.0.0.0/24. The vendor’s own hosts and the IP addresses of this tenant’s network devices are always allowed. |
Vendor handling options:
| Option | Handling |
|---|---|
| Auto-detect | Detects the network device family from the redirect parameters. |
| Aruba (AOS 8 / Instant / AOS 10) | Web login. |
| Aruba switch (AOS-CX / AOS-S) | MAC authentication + CoA. |
| Cisco IOS-XE / C9800 CWA | MAC authentication + CoA. Cisco IOS appends no client MAC: add ?mac=%{Connection:Client-Mac-Address-Colon} to the url-redirect value of the enforcement profile. |
| Cisco WLC (EWA / LWA) | Web login. |
| Meraki sign-on splash | Web login. |
| Meraki click-through | Grant redirect. |
| Ruckus SmartZone / RUCKUS One | Web login. |
| Fortinet FortiGate / FortiAP | Web login. |
| Juniper Mist | Signed authorize URL (needs the WLAN API secret). |
| Arista EOS | MAC authentication + CoA. |
| Extreme EXOS | MAC authentication + CoA. |
| ExtremeCloud IQ | Grant redirect. |
| UniFi | Parameters are parsed, but granting needs the controller API, which is not supported. Use MAC caching with RADIUS MAC authentication instead. |
| Generic | Generic parameter names; web-login target from the login URL you enter. |
Accounts & devices (not shown for guest-login portals)
| Field | Meaning |
|---|---|
| User name | Self-registration: E-mail address (default), Phone number or Random. |
| Password | Self-registration: Digits, Letters, Letters and digits or None (password-less). |
| Password length | 4 to 64. Default 8. |
| Allowed e-mail domains | Self-registration: the registration e-mail must be in one of these domains (sub-domains included). Empty = any. |
| Registration limit | One registration per e-mail, phone or device MAC in this window, 0 to 8760 hours; 0 = off. |
Receipts
| Field | Meaning |
|---|---|
| Show the credentials on the receipt page after registration | Shows the new credentials on the page. Ignored while sponsors are on. |
| E-mail receipt | Send automatically toggle, Subject and Body (plain text with placeholders such as {{username}} and {{password}}). |
| SMS receipt | Send automatically toggle and Message. Needs an SMS gateway. |
| Sponsors (Microsoft Teams) | Self-registration portals with a password only. When on, visitors choose a sponsor from a drop-down (Question on the form, default Who are you visiting?), and the generated password is sent to that sponsor in a Teams chat instead of to the visitor. Each sponsor has a Name and an E-mail (Teams UPN), up to 500. Paste list accepts one sponsor per line as Name <email>, Name, email or email. Teams delivery must be set up on Guest accounts › Defaults. |
Receipts are sent to guests who register on the portal and are used when an operator re-sends the receipt of an account linked to the portal.
Skin editor
Section titled “Skin editor”| Field | Meaning |
|---|---|
| Name | Required. Up to 64 characters. Built-in skin names are reserved. |
| Start from | New skins only: copies the colours, images, CSS and HTML of an existing skin. |
| Description | Up to 512 characters. |
| Primary (buttons), Background, Text | Colours. Available in CSS as var(--p), var(--bg) and var(--fg). |
| Logo, Background image | PNG, JPEG, GIF, WebP or SVG, up to 1 MiB encoded. |
| CSS | Up to 64 KiB, appended after the portal styles. No @import, no external URLs, no </, expression( or javascript:. |
| Header HTML, Footer HTML | Up to 32 KiB each, rendered before and after the page content. Scripts are blocked. |
Actions
Section titled “Actions”| Action | Where | What it does |
|---|---|---|
| Refresh | Page header | Reloads the portals. |
| New portal | Page header | Opens the editor for a new portal. |
| Live / Off toggle, Enable / Disable | Card, table row | Enables a portal, or asks for confirmation and disables it. While disabled, guests redirected to its URL get a “not found” page; existing accounts, MAC caches and registered devices keep working. |
| Preview | Card, table row | Creates a one-hour preview link that renders the saved portal, even when disabled, with a Preview banner. Forms cannot be submitted. Open preview opens it; With sample NAD parameters adds sample redirect parameters. A new link replaces the previous one. |
| Edit / View settings | Card, table row | Opens the editor. |
| Duplicate | Card, table row | Copies the portal, including its stored secrets, as a new disabled portal and opens it. |
| Delete | Card, table row | Asks for confirmation, then removes the portal and its open portal sessions. Accounts and devices created through it keep working. The seeded guest portal is not re-created. This cannot be undone. |
| Copy URL | Card, table row | Copies the public URL. |
| Create portal / Save changes | Editor | Saves the portal. Ctrl+S also saves. |
| Live preview | Editor | Opens the preview link for the saved version. |
| New skin | Skins tab | Opens the skin editor. |
| Duplicate | Skin card | Creates a copy of the skin (<name> copy) and opens it. Use this to customise a built-in skin. |
| Delete | Skin card (custom only) | Removes the skin. A skin that portals use must be replaced on those portals first. |
Permissions
Section titled “Permissions”- View:
guest:read: Tenant Administrator, Network Administrator, Help Desk, Guest Operator, Read-only Administrator and Platform Administrator. Withoutguest:write, the editors open read-only. - Change:
guest:write: Tenant Administrator, Network Administrator, Help Desk, Guest Operator and Platform Administrator.
Choosing an Authentication service in the editor needs policy:read to list the services.