Radius

Create

Create a new Radius MFA.

POST/api/MFA/Radius

Query parameters

radiusTypeRadiusType (enum)

RADIUS Type

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

Body

MFA settings

name*nullable string

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

siteIdinteger (int32)

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.

descriptionnullable string

A user-defined Multi Factor Authentication description.

enabledboolean

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

radiusServer*nullable string

The server of the second level authentication provider.

radiusPort*nullable integer (int32)

The port number of the second level authentication provider.

passwordEncodingPasswordEncoding (enum)

Password Encoding

0 = PAP,1 = CHAP

retries*nullable integer (int32)

Number of retries.

timeout*nullable integer (int32)

Connection timeout (in seconds).

displayName*nullable string

RADIUS type name.

usernameOnlynullable boolean

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

forwardFirstPwdToADnullable boolean

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

backupServernullable string

The backup server of the second level authentication provider.

haModeHAMode (enum)

High Availability Mode

0 = Parallel,1 = Serial

secretKey*nullable string

RADIUS setting. The secret key.

userMessagePromptnullable string

User message prompt

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Name

siteIdinteger (int32)

Site ID

descriptionnullable string

Description

enabledboolean

Whether MFA provider is enabled or not.

typeMFAType (enum)

Provider Type

1 = Deepnet,2 = SafeNet,3 = Radius,4 = AzureRadius,5 = DuoRadius,6 = FortiRadius,7 = TekRadius,8 = GAuthTOTP,9 = TOTP,10 = MicrosoftTOTP,11 = EmailOTP

inheritDefaultCriteriaSettingsboolean

If true default criteria restriction settings will be inherited.

criteriaMFACriteria (object)

MFA Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

servernullable string

The server of the second level authentication provider.

portinteger (int32)

The port number of the second level authentication provider.

passwordEncodingPasswordEncoding (enum)

Password Encoding

0 = PAP,1 = CHAP

retriesinteger (int32)

Number of retries.

timeoutinteger (int32)

Connection timeout (in seconds).

displayNamenullable string

RADIUS type name.

usernameOnlyboolean

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

forwardFirstPwdToADboolean

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

backupServernullable string

The backup server of the second level authentication provider.

haModeHAMode (enum)

High Availability Mode

0 = Parallel,1 = Serial

attributeInfoListnullable array of MFARadiusAttr (object)

List of the RADIUS attribute information.

vendorIDinteger (int32)

RADIUS attribute vendor ID

attributeIDinteger (int32)

RADIUS attribute ID

attributeTypeRadiusAttrType (enum)

RADIUS attribute type

0 = Number,1 = String,2 = IP,3 = Time

radiusAttrNamenullable string

RADIUS attribute name

vendornullable string

RADIUS attribute vendor name

valuenullable string

RADIUS attribute Value

automationInfoListnullable array of MFARadiusAutoInfo (object)

List of the RADIUS Automation information.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

autoSendboolean

Whether the RADIUS Automation autoSend is enabled or not

commandnullable string

RADIUS Automation command

enabledboolean

Whether RADIUS Automation is enabled/disabled

imageImageType (enum)

Image Type

100 = Alert,101 = Message,102 = Email,103 = Call,104 = Chat,105 = Flag

descriptionnullable string

RADIUS Description

actionMessagenullable string

RADIUS Action Message

titlenullable string

RADIUS Automation title

ignoreErrorsnullable array of string

List of Ignored Errors.

itemsstring

userMessagePromptnullable string

User message prompt

Request

Response

Update

Update the Radius MFA Site Settings.

PUT/api/MFA/Radius/{id}

Path parameters

id*integer (int32)

The ID for which to modify the MFA Radius settings.

Body

MFA settings.

namenullable string

The new name of the target multi-factor authentication .

descriptionnullable string

A user-defined multi-factor authentication description.

enablednullable boolean

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

inheritDefaultCriteriaSettingsnullable boolean

If true default criteria settings will be inherited.

Response

No Content

Request

Response

Update

Update the Radius MFA Site Settings.

PUT/api/MFA/Radius/{id}

Path parameters

id*integer (int32)

The ID for which to modify the MFA Radius settings.

Body

MFA settings.

namenullable string

The new name of the target multi-factor authentication .

descriptionnullable string

A user-defined multi-factor authentication description.

enablednullable boolean

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

inheritDefaultCriteriaSettingsnullable boolean

If true default criteria settings will be inherited.

Response

No Content

Request

Response

Create

Create a new Radius MFA.

POST/api/MFA/Radius

Query parameters

radiusTypeRadiusType (enum)

RADIUS Type

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

Body

MFA settings

name*nullable string

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

siteIdinteger (int32)

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.

descriptionnullable string

A user-defined Multi Factor Authentication description.

enabledboolean

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

radiusServer*nullable string

The server of the second level authentication provider.

radiusPort*nullable integer (int32)

The port number of the second level authentication provider.

passwordEncodingPasswordEncoding (enum)

Password Encoding

0 = PAP,1 = CHAP

retries*nullable integer (int32)

Number of retries.

timeout*nullable integer (int32)

Connection timeout (in seconds).

displayName*nullable string

RADIUS type name.

usernameOnlynullable boolean

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

forwardFirstPwdToADnullable boolean

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

backupServernullable string

The backup server of the second level authentication provider.

haModeHAMode (enum)

High Availability Mode

0 = Parallel,1 = Serial

secretKey*nullable string

RADIUS setting. The secret key.

userMessagePromptnullable string

User message prompt

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Name

siteIdinteger (int32)

Site ID

descriptionnullable string

Description

enabledboolean

Whether MFA provider is enabled or not.

typeMFAType (enum)

Provider Type

1 = Deepnet,2 = SafeNet,3 = Radius,4 = AzureRadius,5 = DuoRadius,6 = FortiRadius,7 = TekRadius,8 = GAuthTOTP,9 = TOTP,10 = MicrosoftTOTP,11 = EmailOTP

inheritDefaultCriteriaSettingsboolean

If true default criteria restriction settings will be inherited.

criteriaMFACriteria (object)

MFA Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

servernullable string

The server of the second level authentication provider.

portinteger (int32)

The port number of the second level authentication provider.

passwordEncodingPasswordEncoding (enum)

Password Encoding

0 = PAP,1 = CHAP

retriesinteger (int32)

Number of retries.

timeoutinteger (int32)

Connection timeout (in seconds).

displayNamenullable string

RADIUS type name.

usernameOnlyboolean

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

forwardFirstPwdToADboolean

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

backupServernullable string

The backup server of the second level authentication provider.

haModeHAMode (enum)

High Availability Mode

0 = Parallel,1 = Serial

attributeInfoListnullable array of MFARadiusAttr (object)

List of the RADIUS attribute information.

vendorIDinteger (int32)

RADIUS attribute vendor ID

attributeIDinteger (int32)

RADIUS attribute ID

attributeTypeRadiusAttrType (enum)

RADIUS attribute type

0 = Number,1 = String,2 = IP,3 = Time

radiusAttrNamenullable string

RADIUS attribute name

vendornullable string

RADIUS attribute vendor name

valuenullable string

RADIUS attribute Value

automationInfoListnullable array of MFARadiusAutoInfo (object)

List of the RADIUS Automation information.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

autoSendboolean

Whether the RADIUS Automation autoSend is enabled or not

commandnullable string

RADIUS Automation command

enabledboolean

Whether RADIUS Automation is enabled/disabled

imageImageType (enum)

Image Type

100 = Alert,101 = Message,102 = Email,103 = Call,104 = Chat,105 = Flag

descriptionnullable string

RADIUS Description

actionMessagenullable string

RADIUS Action Message

titlenullable string

RADIUS Automation title

ignoreErrorsnullable array of string

List of Ignored Errors.

itemsstring

userMessagePromptnullable string

User message prompt

Request

Response

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