HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Update some fields of a web login page

Update some fields of a web login page

Path Params
string
required

URL parameter id

Body Params
int64

Unique ID of the web login

string
required

Enter a name for this web login page

string

Enter a page name for this web login.
The web login will be accessible from “/guest/page_name.php”

string

Comments or descriptive text about the web login

string
required

Select a predefined group of settings suitable for standard network configurations

string

Enter the hostname (FQDN) of the vendor’s product here.
When using Secure Login over HTTPS, this name should match the name of the HTTPS certificate installed on your device

string

Select a security option to apply to the web login process

string

Select how the user’s network login will be handled.
Server-initiated logins require the user’s MAC address to be available, usually from the captive portal redirection process

string
required

The URL of the NAS device’s login form

string
required

Choose the method to use when submitting the login form to the NAS

string

The form label for the username field.
Leave blank to use the default (Username:)

string
required

The name of the username field for the login form. This will be passed to the NAS device when the form is submitted

string

The suffix is automatically appended to the username before submitting the login form to the NAS

string

The form label for the password field.
Leave blank to use the default (Password:)

string
required

The name of the password field for the login form. This will be passed to the NAS device when the form is submitted

string

Specify any additional field names and values to send to the NAS device as name=value pairs, one per line

string

The form label for the log in button.
Leave blank to use the default (Log In)

string
required

Choose the type of password encryption to use when submitting the login form

string

Enter the shared secret between the NAS device and the web login form

string

The name of the destination field required by the NAS

string

Enter the default URL to redirect clients.
Please ensure you prepend "http://" for any external domain

boolean

If selected, the client’s default destination will be overridden regardless of its value

boolean

In multi-controller deployments, it is often required to post credentials to different addresses made available as part of the original redirection.
The address above will be used whenever the parameter is not available or fails the requirements below

string

Enter the IP addresses and networks from which dynamic addresses are permitted

string

Enter the IP addresses and networks from which dynamic addresses are denied

string

Enter the IP addresses and networks from which logins are permitted

string

Enter the IP addresses and networks that are denied login access

string
required

Select the response of the system to a request that is not permitted

string

The title to display on the web login page.
Leave blank to use the default (Login)

string

HTML template code displayed before the login form

string
string

HTML template code displayed while the login attempt is in progress

double
required

The time in seconds to delay while displaying the login message

string
required

Choose the skin to use when this web login page is displayed

boolean

If checked, the user will be forced to accept a Terms and Conditions checkbox

string

The form label for the terms checkbox.
Leave blank to use the default (Terms:)

string

HTML code containing your Terms and Conditions.
Leave blank to use the default (I accept the terms of use)

string

Select the layout for the terms and conditions text

string

The text to display if the terms are not accepted.
Leave blank to use the default (In order to log in, you must accept the terms and conditions.)

string

Select a CAPTCHA mode

string

Select the authentication requirement.
Access Code requires a single code (username) to be entered.
Anonymous allows a blank form requiring just the terms or a Log In button. A pre-existing account is required.
Auto is similar to anonymous but the page is automatically submitted.
Access Code and Anonymous require the account to have the Username Authentication field set

string

Choose whether the user should select a client certificate when authenticating

string

The account to use for anonymous authentication.
The password will be visible within the HTML.
It is recommended to increase the account Session Limit to the number of guests you wish to support

string

Choose whether other credentials must also be provided in addition to a certificate

boolean

If selected, the endpoint’s attributes will also be updated with other details from the user account

boolean

Customize attributes stored with the endpoint

string

List of name|value pairs to pass along.
user_field | Endpoint Attribute

string

Select the level of checking to apply to URL parameters passed to the web login page.
Use this option to detect when URL parameters have been modified by the user, for example their MAC address

string

The redirection URL will be hashed using this shared secret

boolean

The Apple Captive Network Assistant (CNA) is the pop-up browser shown when joining a network that has a captive portal.
Note that this option may not work with all vendors, depending on how the captive portal is implemented

string

Enter an optional URL to send as the Venue Info URL for CAPPORT RFC-8908.
https://www.rfc-editor.org/rfc/rfc8908.html

boolean

If selected, the guest will be required to pass a health check prior to accessing the network

string

Select the agent options for client scanning.
Native agents are available for Microsoft Windows and Apple OS X. All other OS will fall back to Java

string

HTML template code displayed before the health check text

string
boolean

Enable logins with cloud identity / social network credentials

boolean

Log debugging data

oauth_providers
object

Configuration for cloud identity authentication providers

boolean

If selected, you must supply your own HTML login form in the Header or Footer HTML areas

string
required

Select how the username and password should be checked before proceeding to the NAS authentication

string

The text to display if the username and password lookup fails.
Leave blank to use the default (Invalid username or password)

string
string

All options with credentials must pass the Pre-Auth Check whenever a new user authenticates a device

string
string
string
string
string
string

Enter the number of factors to require

boolean

If disabled, the user must scan the QR code

string
string
string

Enter the hostname of the ImageWare server

string

OAuth 2.0 scope value. Only mc_authn is supported for this release

string

Message which will be displayed on the authorization device

string

Plain text reference to interlock the consumption device and authorization device

string

Authentication Context class reference. Values as specified by ISO/IEC 29115 Clause 6

string

User interface display for Authentication

string

Value to specify to the Authorisation server about type of prompt

int64

Maximum elapsed time in secs since last authenticaiton

string

An indication to IDP on what ID to use for login

string
string

Provide the endpoint URL provided by Mobile Connect during configuration

string

Mobile Connect Redirect URL provided during configuration

string
string
string

HTML template code displayed before the provider’s vendor-specific authentication area

string
Responses

Language
Response
Choose an example:
application/json