=================== Captive portal Show =================== ------- Toolbar ------- .. list-table:: :width: 100 % :widths: 25 25 50 :header-rows: 1 * - Name - Tooltip - Description * - Preview - Preview - * - Clear sessions - Clear captive portal identity sessions - ------ Fields ------ .. list-table:: :width: 100 % :widths: 25 25 50 :header-rows: 1 * - Name - Data type - Description * - Updated by - **string** - **Administrator who last modified this captive portal.** *Indicates the name or identifier of the administrator who last modified the object. Used to track changes and maintain audit history.* * - Created by - **string** - **Administrator who created this captive portal.** *Displays the name or identifier of the administrator who created the object. Automatically populated for tracking and auditing purposes.* * - Name - **string** - **Name of the captive portal.** *Specifies the name of the object. This field is required and should uniquely identify the object within its context.* * - Description - **string** - **Description of this captive portal.** *Provides an optional text description of the object. Useful for documenting purpose, context, or configuration notes.* * - Is enabled - **boolean** - **Whether this captive portal is enabled.** *Indicates whether the object is active or enabled. When disabled, the object becomes inactive or unavailable for use in operations.* * - URL address - **string** - **Public URL address for accessing this captive portal.** * - PKI - **oneOf** MiniListPkiResponse - **PKI certificate authority for secure connections.** *Refers to the Public Key Infrastructure entity associated with the object. Used for certificate management and secure communication.* * - Auth cache lifetime - **number** - **Duration in minutes that authentication is cached.** * - Authorization limit - **number** - **Maximum concurrent authorization limit.** * - Code label - **string** - **Custom label for the verification code field.** * - Code refresh type - **enum** P1D, P7D, P1M - **Method for refreshing authorization codes.** * - Default identity - **oneOf** MiniListIdentityResponse - **Default identity assigned to new users.** * - Default validity - **enum** PT4H, PT8H, PT12H, P1D, P2D, P3D, P5D, P14D, P1M, P2M, P3M, P6M, P1Y - **Default validity period for new accounts.** * - Devices per user limit - **number** - **Maximum devices allowed per user.** * - Email label - **string** - **Custom label for the email field.** * - IP address - **oneOf** MiniListIpAddressResponse - **IP address where the captive portal is hosted.** * - Auto tegister devices - **boolean** - **Whether devices are automatically registered after authentication.** * - Code authorization enabled - **boolean** - **Whether code-based authorization is enabled.** * - Disable change password - **boolean** - **Whether password change is disabled on the portal.** * - Disable endpoint device configurations - **boolean** - **Whether device configuration downloads are disabled.** * - Disable nacview assistants - **boolean** - **Whether NACVIEW Assistant is disabled on this portal.** * - Disable network login - **boolean** - **Whether network login is disabled.** * - Disable OTP info - **boolean** - **Whether OTP information is hidden.** * - Disable reset password - **boolean** - **Whether password reset is disabled.** * - Endpoint device manual activation - **boolean** - **Whether device activation requires manual approval.** * - Hide logon form - **boolean** - **Whether the login form is hidden.** * - Hide registration form - **boolean** - **Whether the registration form is hidden.** * - Manifest authorization enabled - **boolean** - **Whether manifest-based authorization is enabled.** * - Manual activation - **boolean** - **Whether new accounts require manual activation.** * - Master - **boolean** - **Whether this is the master captive portal.** * - Password Of the day enabled - **boolean** - **Whether password-of-the-day authentication is enabled.** * - Redirect to Https - **boolean** - **Whether HTTP is redirected to HTTPS.** * - Require device registration - **boolean** - **Whether device registration is required.** * - Require sponsor - **boolean** - **Whether sponsor approval is required.** * - Rewrite old devices - **boolean** - **Whether existing devices are updated on reconnect.** * - SMS authorization enabled - **boolean** - **Whether SMS authorization is enabled.** * - Login attempts limit - **number** - **Maximum failed login attempts before lockout.** * - Network post auth redirect - **string** - **Redirect URL after network authentication.** * - OTP apps enabled - **enum** CaptivePortalVerificationType - **Whether OTP apps like Google Authenticator are enabled.** * - Password of the day - **string** - **Value used for password-of-the-day generation.** * - Post auth redirect - **string** - **Custom redirect URL after successful authentication.** * - Preferred locale - **enum** PL, GB, DE, FR, UA, ES, EN - **Preferred language for the portal interface.** * - Require sponsor time - **number** - **Time allowed for sponsor approval.** * - Reset password notify type - **enum** EMAIL, SMS, NACVIEW_AUTHENTICATOR, GOOGLE_AUTHENTICATOR, YUBIKEY - **Notification method for password resets.** * - End user agreement - **string** - **Terms of use that users must accept.** * - Custom header template - **string** - **Custom HTML header template.** * - Custom success message - **string** - **Custom message shown after successful login.** * - Custom header addon template - **string** - **Additional custom HTML for the header.** * - Custom fail message - **string** - **Custom message shown on authentication failure.** * - Custom footer template - **string** - **Custom HTML footer template.** * - Notify register type - **enum** EMAIL, INSTANT, SMS - **Notification method for new registrations.** ------ Panels ------ .. list-table:: :width: 100 % :widths: 25 25 25 25 :header-rows: 1 * - Name - Data type - Template - Description * - API authorization servers - **array** of **entity preview** - Unordered list / Table - **API-based authorization servers configured for user authentication.** * - External subnetworks - **array** of - Unordered list / Table - **External subnetworks allowed to bypass the captive portal.** * - Nacview Assistants - **array** of **entity preview** - Unordered list / Table - **NACVIEW Assistant configurations available for network setup on this portal.** * - Open addresses - **array** of - Unordered list / Table - **Domain names that can bypass the captive portal without authentication.** * - Open IPs - **array** of - Unordered list / Table - **IP addresses and subnets that can bypass the captive portal.** * - Registration forms - **array** of **entity preview** - Unordered list / Table - **Registration forms available for user self-service on this portal.** * - Social authorization servers - **array** of **entity preview** - Unordered list / Table - **Social login providers (Facebook, Google) enabled for authentication.** * - Captive portal sponsors - **array** of **entity preview** - Unordered list / Table - **Sponsors authorized to approve guest access requests.** * - Register object groups - **array** of **entity preview** - Unordered list / Table - **Object groups assigned to newly registered users.** * - Administration groups - **array** of **entity preview** - Unordered list / Table - **Administration groups that can manage this captive portal.**