Radius

Create

post

Create a new Radius MFA.

Query parameters

radiusTypestring · enumOptional

RADIUS Type

Possible values:

Body

application/json; api-version=1.0

Create MFA of type radius

namestring · min: 1 · max: 255 · nullableRequired

The name of the target Multi Factor Authentication. This must be the actual Multi Factor Authentication name used in the RAS farm.

siteIdinteger · int32Optional

Site ID in which to modify the specified Multi Factor Authentication. If the parameter is omitted, the site ID of the Licensing Server will be used.

descriptionstring · nullableOptional

A user-defined Multi Factor Authentication description.

enabledbooleanOptional

Enable or disable the Multi Factor Authentication upon creation. If the parameter is omitted, the Multi Factor Authentication is initialised as Disabled.

radiusServerstring · nullableRequired

The server of the second level authentication provider.

radiusPortinteger · int32 · nullableRequired

The port number of the second level authentication provider.

passwordEncodingstring · enumOptional

Password Encoding

Possible values:

retriesinteger · int32 · nullableRequired

Number of retries.

timeoutinteger · int32 · nullableRequired

Connection timeout (in seconds).

displayNamestring · max: 200 · nullableRequired

RADIUS type name.

usernameOnlyboolean · nullableOptional

Specifies if forwarding of only the Username to RADIUS Server is enabled or not.

forwardFirstPwdToADboolean · nullableOptional

Specifies if forwarding of first password to Windows authentication provider is enabled or not.

backupServerstring · max: 255 · nullableOptional

The backup server of the second level authentication provider.

haModestring · enumOptional

High Availability Mode

Possible values:

secretKeystring · nullableRequired

RADIUS setting. The secret key.

userMessagePromptstring · max: 300 · nullableOptional

User message prompt

Responses

201

Created

application/json; api-version=1.0

MFA Radius Settings

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

namestring · nullableOptional

Name

siteIdinteger · int32Optional

Site ID

descriptionstring · nullableOptional

Description

enabledbooleanOptional

Whether MFA provider is enabled or not.

typestring · enumOptional

Provider Type

Possible values:

inheritDefaultCriteriaSettingsbooleanOptional

If true default criteria restriction settings will be inherited.

serverstring · nullableOptional

The server of the second level authentication provider.

portinteger · int32Optional

The port number of the second level authentication provider.

passwordEncodingstring · enumOptional

Password Encoding

Possible values:

retriesinteger · int32Optional

Number of retries.

timeoutinteger · int32Optional

Connection timeout (in seconds).

displayNamestring · nullableOptional

RADIUS type name.

usernameOnlybooleanOptional

Specifies if forwarding of only the Username to RADIUS Server is enabled or not.

forwardFirstPwdToADbooleanOptional

Specifies if forwarding of first password to Windows authentication provider is enabled or not.

backupServerstring · nullableOptional

The backup server of the second level authentication provider.

haModestring · enumOptional

High Availability Mode

Possible values:

ignoreErrorsstring[] · nullableOptional

List of Ignored Errors.

userMessagePromptstring · nullableOptional

User message prompt

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

/api/MFA/Radius

HTTPcURLJavaScriptPython

POST /api/MFA/Radius HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 371

{
  "name": "text",
  "siteId": 1,
  "description": "text",
  "enabled": true,
  "radiusServer": "text",
  "radiusPort": 1,
  "passwordEncoding": [
    "0 = PAP",
    "1 = CHAP",
    "2 = PAP_UTF8",
    "3 = CHAP_UTF8"
  ],
  "retries": 1,
  "timeout": 1,
  "displayName": "text",
  "usernameOnly": true,
  "forwardFirstPwdToAD": true,
  "backupServer": "text",
  "haMode": [
    "0 = Parallel",
    "1 = Serial"
  ],
  "secretKey": "text",
  "userMessagePrompt": "text"
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-03-11T17:20:06.522Z",
  "timeLastMod": "2026-03-11T17:20:06.522Z",
  "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",
    "2 = PAP_UTF8",
    "3 = CHAP_UTF8"
  ],
  "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"
    }
  ],
  "autoConditions": {
    "enabled": true,
    "default": {
      "id": 1,
      "priority": 1,
      "enabled": true,
      "autoIds": [
        1
      ],
      "patterns": [
        "text"
      ]
    },
    "autoConditionsList": [
      {
        "id": 1,
        "priority": 1,
        "enabled": true,
        "autoIds": [
          1
        ],
        "patterns": [
          "text"
        ]
      }
    ]
  },
  "ignoreErrors": [
    "text"
  ],
  "userMessagePrompt": "text"
}

Update

put

Update the Radius MFA Site Settings.

Path parameters

idinteger · int32Required

The ID for which to modify the MFA Radius settings.

Body

application/json; api-version=1.0

Update MFA of type radius

namestring · min: 1 · max: 255 · nullableOptional

The new name of the target multi-factor authentication .

descriptionstring · nullableOptional

A user-defined multi-factor authentication description.

enabledboolean · nullableOptional

Enable or disable the specified multi-factor authentication in a site.

inheritDefaultCriteriaSettingsboolean · nullableOptional

If true default criteria settings will be inherited.

radiusServerstring · nullableOptional

The server of the second level authentication provider.

radiusPortinteger · int32 · nullableOptional

The port number of the second level authentication provider.

passwordEncodingstring · enumOptional

Password Encoding

Possible values:

retriesinteger · int32 · nullableOptional

Number of retries.

timeoutinteger · int32 · nullableOptional

Connection timeout (in seconds).

displayNamestring · max: 200 · nullableOptional

RADIUS type name.

usernameOnlyboolean · nullableOptional

Specifies if forwarding of only the Username to RADIUS Server is enabled or not.

forwardFirstPwdToADboolean · nullableOptional

Specifies if forwarding of first password to Windows authentication provider is enabled or not.

backupServerstring · max: 255 · nullableOptional

The backup server of the second level authentication provider.

haModestring · enumOptional

High Availability Mode

Possible values:

secretKeystring · nullableOptional

RADIUS setting. The secret key.

ignoreErrorsstring[] · nullableOptional

Specifies the list of Ignored Errors. This is a DuoRadius only setting.

autoConditionsEnabledboolean · nullableOptional

Enable or disable the RADIUS Automation Conditions.

defaultUserMessagePromptbooleanOptional

If this parameter is included, the message prompt will be replaced with the default message prompt.

Default: false

userMessagePromptstring · max: 300 · nullableOptional

User message prompt

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/MFA/Radius/{id}

HTTPcURLJavaScriptPython

PUT /api/MFA/Radius/{id} HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 484

{
  "name": "text",
  "description": "text",
  "enabled": true,
  "inheritDefaultCriteriaSettings": true,
  "radiusServer": "text",
  "radiusPort": 1,
  "passwordEncoding": [
    "0 = PAP",
    "1 = CHAP",
    "2 = PAP_UTF8",
    "3 = CHAP_UTF8"
  ],
  "retries": 1,
  "timeout": 1,
  "displayName": "text",
  "usernameOnly": true,
  "forwardFirstPwdToAD": true,
  "backupServer": "text",
  "haMode": [
    "0 = Parallel",
    "1 = Serial"
  ],
  "secretKey": "text",
  "ignoreErrors": [
    "text"
  ],
  "autoConditionsEnabled": true,
  "defaultUserMessagePrompt": false,
  "userMessagePrompt": "text"
}

No content