======================== Edit captive portal Form ======================== ------- Toolbar ------- ------ Fields ------ .. list-table:: :width: 100 % :widths: 25 25 50 :header-rows: 1 * - Name - Data type - Description * - Master - **boolean** - **Designates this captive portal as the master portal that handles authentication for the entire system.** * - Name - **string** - **The unique name identifier for this captive portal configuration.** * - Description - **string** - **Additional description visible to all NACVIEW users about this captive portal.** * - Is enabled - **boolean** - **Indicates whether this captive portal is active and accepting user authentications.** * - Preferred locale - **enum** PL, GB, DE, FR, UA, ES, EN - **The preferred language for the captive portal interface (e.g., en, pl).** * - PKI - **oneOf** NestedIdentifier - **The PKI certificate authority used for secure HTTPS connections and client certificates.** * - IP address - **oneOf** NestedIdentifier - **The IP address where the captive portal is hosted.** * - End user agreement - **string** - **The terms of use and end-user agreement text that users must accept before network access.** * - External subnetworks - **array** of - **External subnetworks that are allowed to access the captive portal without authentication.** * - Open addresses - **array** of - **Domain names that are allowed to bypass the captive portal (e.g., company.local).** * - Open IPs - **array** of - **IP addresses or subnets that are allowed to bypass the captive portal without authentication.** * - Authorization servers API - **array** of **entity preview** - **External API-based authorization servers used for user authentication.** * - Social authorization servers - **array** of **entity preview** - **Social login providers (Facebook, Google) for user authentication.** * - Nacview assistants - **array** of **entity preview** - **NACVIEW Assistant configurations available on this captive portal for network setup.** * - Administration groups - **array** of **entity preview** - **Administration groups that can manage this captive portal configuration.** ------ Panels ------ More options ============ .. list-table:: :width: 100 % :widths: 25 25 50 :header-rows: 1 * - Name - Data type - Description * - Hide registration form - **boolean** - **Hide the self-registration form from the captive portal login page.** * - Hide logon form - **boolean** - **Hide the standard username/password login form from the captive portal.** * - Disable change password - **boolean** - **Disable the ability for users to change their password through the captive portal.** * - Disable endpoint device configurations - **boolean** - **Disable the display of endpoint device configuration downloads on the portal.** * - Disable nacview assistants - **boolean** - **Disable NACVIEW Assistant configuration downloads from this captive portal.** * - Disable network login - **boolean** - **Disable the network login option on the captive portal.** * - Disable OTP info - **boolean** - **Disable the display of OTP (One-Time Password) information on the portal.** * - Disable reset password - **boolean** - **Disable the password reset functionality on the captive portal.** * - Auto register devices - **boolean** - **Automatically register devices in NACVIEW upon successful authentication without manual approval.** * - Endpoint device manual activation - **boolean** - **Require manual activation by an administrator before devices can access the network.** * - Manifest authorization enabled - **boolean** - **Enable manifest-based authorization where device compliance is verified before access is granted.** * - Code authorization enabled - **boolean** - **Enable code-based authorization where users receive a verification code via email or SMS.** * - SMS authorization enabled - **boolean** - **Enable SMS-based authorization where users receive verification codes via text message.** * - Redirect to HTTPS - **boolean** - **Automatically redirect HTTP connections to HTTPS for secure communication.** * - Manual activation - **boolean** - **Require manual activation by an administrator before new user accounts can access the network.** * - Password of the day - **boolean** - **Enable password-of-the-day authentication where a new password is generated daily.** * - Require device registration - **boolean** - **Require users to register their devices before accessing the network.** * - Rewrite old devices - **boolean** - **Automatically update existing device records when the same device reconnects.** * - Authorization cache lifetime - **number** - **The duration in minutes that authentication results are cached before requiring re-authentication.** * - Devices per user limit - **number** - **Maximum number of devices that a single user can register on this captive portal.** * - Code refresh type - **enum** P1D, P7D, P1M - **The method for refreshing authorization codes (e.g., manual, automatic).** * - Default identity - **oneOf** NestedIdentifier - **The default identity to assign to users who authenticate through this portal.** * - Default validity - **enum** PT4H, PT8H, PT12H, P1D, P2D, P3D, P5D, P14D, P1M, P2M, P3M, P6M, P1Y - **Default validity period for new user accounts created through this captive portal.** * - URL address - **string** - **The public URL address where users access this captive portal.** * - Authorization limit - **number** - **Maximum number of concurrent authorizations allowed through this captive portal.** * - Password of the day value - **string** - **The value or pattern used to generate the daily password when password-of-the-day is enabled.** * - Login attempts limit - **number** - **Maximum number of failed login attempts before the account is temporarily locked.** * - Network post auth. redirect - **string** - **The URL to redirect users to after successful network authentication.** * - OTP apps enabled - **enum** CaptivePortalVerificationType - **Enable OTP (One-Time Password) applications like Google Authenticator for two-factor authentication.** * - MFA type - **enum** CaptivePortalVerificationType - **The type of multi-factor authentication method used by this captive portal.** * - Post auth redirect - **string** - **Custom URL to redirect users to after successful authentication.** * - Reset password notify type - **enum** EMAIL, SMS, NACVIEW_AUTHENTICATOR, GOOGLE_AUTHENTICATOR, YUBIKEY - **Method for notifying users about password reset requests (e.g., email, SMS).** * - Identity personal data is required - **boolean** - **Require users to provide personal data (name, email, etc.) during registration.** * - Register object groups - **array** of **entity preview** - **Object groups to which newly registered users are automatically assigned.** * - Notify register type - **enum** EMAIL, INSTANT, SMS - **Method for notifying administrators about new user registrations.** More sponsors ============= .. list-table:: :width: 100 % :widths: 25 25 50 :header-rows: 1 * - Name - Data type - Description * - Require sponsor - **boolean** - **Require approval from a sponsor (authorized employee) before granting network access.** * - Require sponsor time - **number** - **Time period within which a sponsor must approve the access request.** * - Code label - **string** - **Custom label displayed for the verification code input field.** * - Email label - **string** - **Custom label displayed for the email address input field.** * - Captive portal sponsors - **array** of **entity preview** - **List of sponsors authorized to approve guest access requests.** More views ========== .. list-table:: :width: 100 % :widths: 25 25 50 :header-rows: 1 * - Name - Data type - Description * - Custom success message - **string** - **Custom message displayed to users after successful authentication.** * - Custom fail message - **string** - **Custom message displayed to users when authentication fails.** * - Custom header template - **string** - **Custom HTML template for the header section of the captive portal page.** * - Custom footer template - **string** - **Custom HTML template for the footer section of the captive portal page.** * - Custom header addon template - **string** - **Additional custom HTML content to add to the header of the captive portal.**