Replace a web login pageAsk AIput https://clearpass-hostname/api/weblogin/{id}Replace a web login pageRecent RequestsLog in to see full request historyTimeStatusUser Agent Retrieving recent requests…LoadingLoading…Path ParamsidstringrequiredURL parameter idBody Paramsidint64Unique ID of the web loginnamestringrequiredEnter a name for this web login pagepage_namestringEnter a page name for this web login. The web login will be accessible from “/guest/page_name.php”descriptionstringComments or descriptive text about the web loginvendor_presetstringrequiredSelect a predefined group of settings suitable for standard network configurationsvendor_ipstringEnter 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 devicerequire_httpsstringSelect a security option to apply to the web login processwebauthstringSelect 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 processform_actionstringrequiredThe URL of the NAS device’s login formform_methodstringrequiredChoose the method to use when submitting the login form to the NASform_username_labelstringThe form label for the username field. Leave blank to use the default (Username:)form_usernamestringrequiredThe name of the username field for the login form. This will be passed to the NAS device when the form is submittedform_username_suffixstringThe suffix is automatically appended to the username before submitting the login form to the NASform_password_labelstringThe form label for the password field. Leave blank to use the default (Password:)form_passwordstringrequiredThe name of the password field for the login form. This will be passed to the NAS device when the form is submittedform_extrastringSpecify any additional field names and values to send to the NAS device as name=value pairs, one per linesubmit_labelstringThe form label for the log in button. Leave blank to use the default (Log In)form_password_encryptionstringrequiredChoose the type of password encryption to use when submitting the login formuam_secretstringEnter the shared secret between the NAS device and the web login formurlstringThe name of the destination field required by the NASdefault_urlstringEnter the default URL to redirect clients. Please ensure you prepend "http://" for any external domaindefault_url_overridebooleanIf selected, the client’s default destination will be overridden regardless of its valuetruefalsedynamic_addressbooleanIn 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 belowtruefalsedynamic_allowliststringEnter the IP addresses and networks from which dynamic addresses are permitteddynamic_denyliststringEnter the IP addresses and networks from which dynamic addresses are deniedaccess_allowliststringEnter the IP addresses and networks from which logins are permittedaccess_denyliststringEnter the IP addresses and networks that are denied login accessaccess_if_deniedstringrequiredSelect the response of the system to a request that is not permittedlogin_titlestringThe title to display on the web login page. Leave blank to use the default (Login)login_headerstringHTML template code displayed before the login formlogin_footerstringHTML template code displayed after the login formlogin_messagestringHTML template code displayed while the login attempt is in progresslogin_delaydoublerequiredThe time in seconds to delay while displaying the login messagelogin_skinstringrequiredChoose the skin to use when this web login page is displayedlogin_terms_requirebooleanIf checked, the user will be forced to accept a Terms and Conditions checkboxtruefalselogin_terms_labelstringThe form label for the terms checkbox. Leave blank to use the default (Terms:)login_terms_textstringHTML code containing your Terms and Conditions. Leave blank to use the default (I accept the terms of use)login_terms_layoutstringSelect the layout for the terms and conditions textlogin_terms_errorstringThe 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.)login_captchastringSelect a CAPTCHA modeusername_authstringSelect 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 setcertificate_requeststringChoose whether the user should select a client certificate when authenticatingusername_auth_usernamestringThe 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 supportcertificate_authstringChoose whether other credentials must also be provided in addition to a certificateregister_policy_managerbooleanIf selected, the endpoint’s attributes will also be updated with other details from the user accounttruefalseregister_policy_manager_advbooleanCustomize attributes stored with the endpointtruefalseregister_policy_manager_attrsstringList of name|value pairs to pass along. user_field | Endpoint Attributehash_urlstringSelect 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 addresshash_secretstringThe redirection URL will be hashed using this shared secretbypass_cnabooleanThe 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 implementedtruefalsecapport_venue_urlstringEnter an optional URL to send as the Venue Info URL for CAPPORT RFC-8908. https://www.rfc-editor.org/rfc/rfc8908.htmlonguard_healthcheckbooleanIf selected, the guest will be required to pass a health check prior to accessing the networktruefalseonguard_agentsstringSelect the agent options for client scanning. Native agents are available for Microsoft Windows and Apple OS X. All other OS will fall back to Javaonguard_headerstringHTML template code displayed before the health check textonguard_footerstringHTML template code displayed after the health check textoauth_enabledbooleanEnable logins with cloud identity / social network credentialstruefalseoauth_debugbooleanLog debugging datatruefalseoauth_providersobjectConfiguration for cloud identity authentication providersoauth_providers objectlogin_custom_formbooleanIf selected, you must supply your own HTML login form in the Header or Footer HTML areastruefalselogin_pre_auth_checkstringrequiredSelect how the username and password should be checked before proceeding to the NAS authenticationlogin_pre_auth_errorstringThe text to display if the username and password lookup fails. Leave blank to use the default (Invalid username or password)mfa_enabledstringmfa_firststringAll options with credentials must pass the Pre-Auth Check whenever a new user authenticates a devicemfa_duo_ikeystringmfa_duo_skeystringmfa_duo_hoststringmfa_fn_client_idstringmfa_fn_client_secretstringmfa_fn_factorsstringEnter the number of factors to requiremfa_fn_emailbooleanIf disabled, the user must scan the QR codetruefalsemfa_iws_tenantstringmfa_iws_appstringmfa_iws_hostnamestringEnter the hostname of the ImageWare servermfa_mc_scopestringOAuth 2.0 scope value. Only mc_authn is supported for this releasemfa_mc_contextstringMessage which will be displayed on the authorization devicemfa_mc_binding_messagestringPlain text reference to interlock the consumption device and authorization devicemfa_mc_acr_valuesstringAuthentication Context class reference. Values as specified by ISO/IEC 29115 Clause 6mfa_mc_displaystringUser interface display for Authenticationmfa_mc_promptstringValue to specify to the Authorisation server about type of promptmfa_mc_max_ageint64Maximum elapsed time in secs since last authenticaitonmfa_mc_login_hintstringAn indication to IDP on what ID to use for loginmfa_mc_versionstringmfa_mc_discovery_service_endpointstringProvide the endpoint URL provided by Mobile Connect during configurationmfa_mc_redirect_urlstringMobile Connect Redirect URL provided during configurationmfa_mc_client_idstringmfa_mc_client_secretstringmfa_header_htmlstringHTML template code displayed before the provider’s vendor-specific authentication areamfa_footer_htmlstringHTML template code displayed after the provider’s vendor-specific authentication areaResponses 200OK 204No Content 304Not Modified 401Unauthorized 403Forbidden 404Not Found 406Not Acceptable 415Unsupported Media Type 422Unprocessable EntityUpdated over 2 years ago