Fortinet black logo

Administration Guide

Home FortiPresence 1.2.0 Administration Guide
1.2.0
1.2.0

Portal Settings

Portal Settings

This section describes some additional FortiPresence VM settings.

Navigate to Portal > Portal Settings.

Setting Description
RADIUS Clients

Configure FortiAPCloud/FortiGate/ FortiWLC as RADIUS clients for portal authentication. The list of exempted FQDNs for FortiAPCloud, FortiGate, and FortiWLC are displayed here. See Configuring Captive Portal.

Note: You can edit and delete the RADIUS clients.
Auth Provider

The authentication provider settings enable you to configure the credentials derived from the Facebook, Google, Instagram, and LinkedIn applications that you use for portal authentication.

SMS Provider

You can add multiple SMS providers to set up SMS OTP login support for captive portals.

Specify the name and description of the SMS provider. The supported SMS service type is HTTP API and the HTTP GET and POST methods are permitted.

When defining the HTTP API call for both GET and POST methods, %PHONENUMBER% and %MESSAGE% variables MUST be included. These variables act as place holders and get their data from the portal which is used by the user to login to the captive portal enabled SSID.

  • %PHONENUMBER% - The mobile number provided by the user trying to authenticate to the captive portal enabled SSID. This number receives the OTP details.
  • %MESSAGE% - The SMS text that is sent along with the OTP to the user provided mobile number.
    The SMS text can be customised through the SMS template while creating a portal.

Consider the following example:

  1. Resource URL is https://api.textlocal.in/send/ and data = urllib.parse.urlencode({'apikey': apikey, 'numbers': numbers,'message' : message, 'sender': sender})
  2. Then the API URL will be https://api.textlocal.in/send/?apikey=<API KEY provided by the SMS provider>&numbers=numbers&message=message&sender=sender
  3. Replace the numbers and message variables in the API URL https://api.textlocal.in/send/?apikey=a12344rewrwreoi89&numbers=%PHONENUMBER%&message=%MESSAGE%&sender=TXTLCL

Notes:

  • FortiPresence VM encodes only the %PHONENUMBER% and %MESSAGE% variables.
    Note: The requirement for parameters and their encoding varies based on the SMS provider. You are required to obtain information regarding the API, parameters and their encoding from the SMS providers.
    Encode all other variables based on the SMS provider requirements.
  • For the HTTP GET method, %PHONENUMBER% and %MESSAGE% variables are always encoded by FortiPresence; for the HTTP POST method, %PHONENUMBER% and %MESSAGE% variables are encoded by FortiPresence VM only when the HTTP header is defined as follows:
    • Key: Content-Type
    • Value: application/x-www-form-urlencoded

Once the SMS provider is configured, the providers can either be attached to new or existing portals.

Navigate to Portal > Portal Management (add new portal or edit an existing portal). See Portal Management.

s

Previous
Next

Portal Settings

This section describes some additional FortiPresence VM settings.

Navigate to Portal > Portal Settings.

Setting Description
RADIUS Clients

Configure FortiAPCloud/FortiGate/ FortiWLC as RADIUS clients for portal authentication. The list of exempted FQDNs for FortiAPCloud, FortiGate, and FortiWLC are displayed here. See Configuring Captive Portal.

Note: You can edit and delete the RADIUS clients.
Auth Provider

The authentication provider settings enable you to configure the credentials derived from the Facebook, Google, Instagram, and LinkedIn applications that you use for portal authentication.

SMS Provider

You can add multiple SMS providers to set up SMS OTP login support for captive portals.

Specify the name and description of the SMS provider. The supported SMS service type is HTTP API and the HTTP GET and POST methods are permitted.

When defining the HTTP API call for both GET and POST methods, %PHONENUMBER% and %MESSAGE% variables MUST be included. These variables act as place holders and get their data from the portal which is used by the user to login to the captive portal enabled SSID.

  • %PHONENUMBER% - The mobile number provided by the user trying to authenticate to the captive portal enabled SSID. This number receives the OTP details.
  • %MESSAGE% - The SMS text that is sent along with the OTP to the user provided mobile number.
    The SMS text can be customised through the SMS template while creating a portal.

Consider the following example:

  1. Resource URL is https://api.textlocal.in/send/ and data = urllib.parse.urlencode({'apikey': apikey, 'numbers': numbers,'message' : message, 'sender': sender})
  2. Then the API URL will be https://api.textlocal.in/send/?apikey=<API KEY provided by the SMS provider>&numbers=numbers&message=message&sender=sender
  3. Replace the numbers and message variables in the API URL https://api.textlocal.in/send/?apikey=a12344rewrwreoi89&numbers=%PHONENUMBER%&message=%MESSAGE%&sender=TXTLCL

Notes:

  • FortiPresence VM encodes only the %PHONENUMBER% and %MESSAGE% variables.
    Note: The requirement for parameters and their encoding varies based on the SMS provider. You are required to obtain information regarding the API, parameters and their encoding from the SMS providers.
    Encode all other variables based on the SMS provider requirements.
  • For the HTTP GET method, %PHONENUMBER% and %MESSAGE% variables are always encoded by FortiPresence; for the HTTP POST method, %PHONENUMBER% and %MESSAGE% variables are encoded by FortiPresence VM only when the HTTP header is defined as follows:
    • Key: Content-Type
    • Value: application/x-www-form-urlencoded

Once the SMS provider is configured, the providers can either be attached to new or existing portals.

Navigate to Portal > Portal Management (add new portal or edit an existing portal). See Portal Management.

s

Previous
Next