Sophos API Doc.

Operation:	Configure Captive Portal
Description:	Configure Captive Portal page.

Sample Configuration

<FirewallAuthentication> <CaptivePortalSettings> <RedirectUnAuthenticatedUser>Yes/No</RedirectUnAuthenticatedUser> <UnAuthenticatedUserSettings>CaptivePortal/CustomMessage</UnAuthenticatedUserSettings> <HTTPSRedirection>Enable/Disable</HTTPSRedirection> <ShowMyAccountLink>Enable/Disable</ShowMyAccountLink> <URLRedirectionAfterLogin>Enable/Disable</URLRedirectionAfterLogin> <URLToRedirect>UserRequestedURL/{CustomURL}</URLToRedirect> <PreserveCaptivePortalAfterLogin>Yes/No</PreserveCaptivePortalAfterLogin> <KeepAliveRequestForCaptivePortal>Enable/Disable</KeepAliveRequestForCaptivePortal> <UserInactivityTimeout>Unlimited/Disable</UserInactivityTimeout> <CustomURL>url</CustomURL> <UserInactivityTimeoutMinutes>Unlimited/{minutes}</UserInactivityTimeoutMinutes> <DataTransferThreshold>Bytes</DataTransferThreshold> <PageHeaderImage>Default/Custom</PageHeaderImage>  <PageHeaderImageFile>FileName</PageHeaderImageFile> <PageFooterImage>Default/Custom</PageFooterImage>  <PageFooterImageFile>FileName</PageFooterImageFile>  <CustomMessage>Text</CustomMessage> <BlinkCustomMessage>Enable/Disable</BlinkCustomMessage> </CaptivePortalSettings> </FirewallAuthentication>

Attribute/Parameter Information :

Parameter	Mandatory	Default	Description
KeepAliveRequestForCaptivePortal	No	Enable	Description: Enable Keep Alive Requests to check if user has logged out. KeepAliveRequestForCaptivePortal confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'Y', 'N', 'n', 'y' are allowed.
HTTPSRedirection	No	Disable	Description: Enable HTTPS Redirection for secure access to Captive Portal page. HTTPSRedirection confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only '1', '0' are allowed.
CustomURL	Yes		Description: Enable to redirect the user when he logs into the Captive Portal page of the browser. CustomURL confines to: Type is 'SCALAR'. Datatype is 'STRING'.
URLToRedirect	No		Description: Specify the URL to which the user must be redirected after logging into the Captive Portal page. URLToRedirect confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'true', 'false' are allowed.
UserInactivityTimeout	No		Description: Enable to allow users to remain logged in. UserInactivityTimeout confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'checkbox' are allowed.
UserInactivityTimeoutMinutes	Yes	Disable	Description: Specify the time out in minutes after which the user will be logged out and must re-authenticate. UserInactivityTimeoutMinutes confines to: Type is 'SCALAR'. Datatype is 'INTEGER'. Range 3 to 1440 is allowed. Maximum digits allowed are 4.
ShowMyAccountLink	No	Enable	Description: Enable to show My Account Link on the Captive Portal page. ShowMyAccountLink confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only '1', '0' are allowed.
URLRedirectionAfterLogin	No	Disable	Description: Enable to redirect the user after logging to the Captive Portal page. URLRedirectionAfterLogin confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'true', 'false' are allowed.
PageFooterImage	No		Description: Select 'Default' or 'Custom' image to be displayed at the top of the login page. PageFooterImage confines to: Type is 'SCALAR'. Datatype is 'STRING'.
LinuxCorporateClientDownloadLink	No		Description: Enable to provide a link to download the Linux Corporate Client on the login page. LinuxCorporateClientDownloadLink confines to: Type is 'SCALAR'. Datatype is 'STRING'. Note: Applicable only for Custom Message.
PreserveCaptivePortalAfterLogin	Yes	Y	Description: Select option to display the captive portal popup on successful authentication of the user. PreserveCaptivePortalAfterLogin confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'N', 'Y' are allowed.
BlinkCustomMessage	No	Disbale	Description: Enable to display blinking message. BlinkCustomMessage confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only 'on' are allowed.
PageHeaderImage	No		Description: Select 'Default' or 'Custom' image to be displayed at the top of the login page. PageHeaderImage confines to: Type is 'SCALAR'. Datatype is 'STRING'. Note: Applicable only for Custom Message.
PageFooterImageFile	No		Description: Select 'Default' or 'Custom' image to be displayed at the bottom of the login page. PageFooterImageFile confines to: Type is 'SCALAR'. Datatype is 'STRING'. File formats 'jpg', 'gif', 'bmp', 'png', 'jpeg', 'jpe', 'JPG', 'GIF', 'BMP', 'PNG', 'JPEG' are allowed. Note: Applicable only for Custom Message.
MacCorporateClientDownloadLink	No		Description: Enable to provide a link to download the MAC Corporate Client on the login page. MacCorporateClientDownloadLink confines to: Type is 'SCALAR'. Datatype is 'STRING'. Note: Applicable only for Custom Message.
WindowsCorporateClientDownloadLink	No		Description: Enable to provide a link to download the Windows Corporate Client on the login page. WindowsCorporateClientDownloadLink confines to: Type is 'SCALAR'. Datatype is 'STRING'. Note: Applicable only for Custom Message.
PageHeaderImageFile	No		Description: Select 'Default' or 'Custom' image to be displayed at the bottom of the login page. PageHeaderImageFile confines to: Type is 'SCALAR'. Datatype is 'STRING'. File formats 'jpg', 'gif', 'bmp', 'png', 'jpeg', 'jpe', 'JPG', 'GIF', 'BMP', 'PNG', 'JPEG' are allowed.
DataTransferThreshold	Yes	100	Description: Specify threshold value in Bytes for Data Transfer. DataTransferThreshold confines to: Type is 'SCALAR'. Datatype is 'INTEGER'. Maximum digits allowed are 10.
CustomMessage	No		Description: Specify a custom message to be displayed on the login page. CustomMessage confines to: Type is 'SCALAR'. Datatype is 'STRING'.
RedirectUnAuthenticatedUser	Yes		Description: Select 'Yes' to redirect unauthenticated user to the Captive Portal or Custom Message page. Select 'No' to display 'Access Denied' message to the user. RedirectUnAuthenticatedUser confines to: Type is 'SCALAR'. Datatype is 'STRING'. Only '0', '1' are allowed.

Status Message Information :

Operation	Status	Message
Configure Captive Portal	200
Configure Captive Portal	500

Sophos is registered trademarks of Sophos Limited and Sophos Group. All other product and company names mentioned are trademarks or registered trademarks of their respective owners.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording or otherwise unless you are either a valid licensee where the documentation can be reproduced in accordance with the license terms or you otherwise have the prior permission in writing of the copyright owner.