Radius

PreviousEmail OTP NextRadius Attributes

Was this helpful?

Create

post

Create a new Radius MFA.

Query parameters

radiusTypestring · enum

<para type="synopsis">RADIUS Type</para> <para type="description"></para>

Options: 3 = Radius,4 = AzureRadius,5 = DuoRadius,6 = FortiRadius,7 = TekRadius

Body

namestring | nullablerequired

<para type="description">The name of the target Multi Factor Authentication.</para> <para type="description">This must be the actual Multi Factor Authentication name used in the RAS farm.</para>

siteIdinteger · int32

<para type="description">Site ID in which to modify the specified Multi Factor Authentication.</para> <para type="description">If the parameter is omitted, the site ID of the Licensing Server will be used.</para>

descriptionstring | nullable

<para type="description">A user-defined Multi Factor Authentication description.</para>

enabledboolean

<para type="description">Enable or disable the Multi Factor Authentication upon creation.</para> <para type="description">If the parameter is omitted, the Multi Factor Authentication is initialised as Disabled.</para>

radiusServerstring | nullablerequired

<para type="description">The server of the second level authentication provider.</para>

radiusPortinteger · int32 | nullablerequired

<para type="description">The port number of the second level authentication provider.</para>

passwordEncodingstring · enum

<para type="synopsis">Password Encoding</para> <para type="description"></para>

Options: 0 = PAP,1 = CHAP

retriesinteger · int32 | nullablerequired

<para type="description">Number of retries.</para>

timeoutinteger · int32 | nullablerequired

<para type="description">Connection timeout (in seconds).</para>

displayNamestring | nullablerequired

<para type="description">RADIUS type name.</para>

usernameOnlyboolean | nullable

<para type="description">Specifies if forwarding of only the Username to RADIUS Server is enabled or not.</para>

forwardFirstPwdToADboolean | nullable

<para type="description">Specifies if forwarding of first password to Windows authentication provider is enabled or not.</para>

backupServerstring | nullable

<para type="description">The backup server of the second level authentication provider.</para>

haModestring · enum

<para type="synopsis">High Availability Mode</para> <para type="description"></para>

Options: 0 = Parallel,1 = Serial

secretKeystring | nullablerequired

<para type="description">RADIUS setting. The secret key.</para>

userMessagePromptstring | nullable

<para type="description">User message prompt</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/MFA/Radius' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "siteId": 1,
    "description": "text",
    "enabled": true,
    "radiusServer": "text",
    "radiusPort": 1,
    "passwordEncoding": [
      "0 = PAP",
      "1 = CHAP"
    ],
    "retries": 1,
    "timeout": 1,
    "displayName": "text",
    "usernameOnly": true,
    "forwardFirstPwdToAD": true,
    "backupServer": "text",
    "haMode": [
      "0 = Parallel",
      "1 = Serial"
    ],
    "secretKey": "text",
    "userMessagePrompt": "text"
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-20T23:29:14.657Z",
  "timeLastMod": "2025-03-20T23:29:14.657Z",
  "name": "text",
  "siteId": 1,
  "description": "text",
  "enabled": true,
  "type": [
    "1 = Deepnet",
    "2 = SafeNet",
    "3 = Radius",
    "4 = AzureRadius",
    "5 = DuoRadius",
    "6 = FortiRadius",
    "7 = TekRadius",
    "8 = GAuthTOTP",
    "9 = TOTP",
    "10 = MicrosoftTOTP",
    "11 = EmailOTP"
  ],
  "inheritDefaultCriteriaSettings": true,
  "criteria": {
    "securityPrincipals": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "members": [
        {
          "account": "text",
          "type": [
            "1 = User",
            "2 = Group",
            "3 = ForeignSecurityPrincipal",
            "4 = Computer"
          ],
          "sid": "text"
        }
      ]
    },
    "gateways": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "members": [
        {
          "gatewayIP": "text"
        }
      ]
    },
    "oSs": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "allowedOSes": {
        "chrome": true,
        "android": true,
        "webClient": true,
        "iOS": true,
        "linux": true,
        "mac": true,
        "wyse": true,
        "windows": true
      }
    },
    "iPs": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "allowedIPs": {
        "iPv4s": [
          {
            "from": "text",
            "to": "text"
          }
        ],
        "iPv6s": [
          {
            "from": "text",
            "to": "text"
          }
        ]
      }
    },
    "hardwareIDs": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "members": [
        {
          "hardwareID": "text"
        }
      ]
    },
    "access": [
      "0 = DenyCriteriaWhen",
      "1 = AllowCriteriaWhen"
    ],
    "devices": {
      "enabled": true,
      "matchingMode": [
        "0 = IsNotOneOfTheFollowing",
        "1 = IsOneOfTheFollowing"
      ],
      "members": [
        {
          "client": "text"
        }
      ]
    }
  },
  "server": "text",
  "port": 1,
  "passwordEncoding": [
    "0 = PAP",
    "1 = CHAP"
  ],
  "retries": 1,
  "timeout": 1,
  "displayName": "text",
  "usernameOnly": true,
  "forwardFirstPwdToAD": true,
  "backupServer": "text",
  "haMode": [
    "0 = Parallel",
    "1 = Serial"
  ],
  "attributeInfoList": [
    {
      "vendorID": 1,
      "attributeID": 1,
      "attributeType": [
        "0 = Number",
        "1 = String",
        "2 = IP",
        "3 = Time"
      ],
      "radiusAttrName": "text",
      "vendor": "text",
      "value": "text"
    }
  ],
  "automationInfoList": [
    {
      "id": 1,
      "priority": 1,
      "autoSend": true,
      "command": "text",
      "enabled": true,
      "image": [
        "100 = Alert",
        "101 = Message",
        "102 = Email",
        "103 = Call",
        "104 = Chat",
        "105 = Flag"
      ],
      "description": "text",
      "actionMessage": "text",
      "title": "text"
    }
  ],
  "ignoreErrors": [
    "text"
  ],
  "userMessagePrompt": "text"
}

Created

Update

put

Update the Radius MFA Site Settings.

Path parameters

idinteger · int32required

The ID for which to modify the MFA Radius settings.

Body

namestring | nullable

<para type="description">The new name of the target multi-factor authentication .</para>

descriptionstring | nullable

<para type="description">A user-defined multi-factor authentication description.</para>

enabledboolean | nullable

<para type="description">Enable or disable the specified multi-factor authentication in a site.</para>

inheritDefaultCriteriaSettingsboolean | nullable

<para type="description">If true default criteria settings will be inherited.</para>