Safenet | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Create

post

Create a new Safenet MFA.

Body

Create MFA of type safenet

namestring | 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.

safenetAuthModestring · enumoptional

SafeNet Authentication Mode

Available options:

otpServiceURLstring | nullablerequired

OTP Service URL

userRepositorystring | nullableoptional

A value representing User Store

tmsWebApiURLstring | nullableoptional

The URL of the web service

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/MFA/Safenet' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "siteId": 1,
    "description": "text",
    "enabled": true,
    "safenetAuthMode": [
      "0 = MandatoryForAllUsers",
      "1 = CreateTokenForDomainAuthenticatedUsers",
      "2 = UsersWithSafeNetAcc"
    ],
    "otpServiceURL": "text",
    "userRepository": "text",
    "tmsWebApiURL": "text"
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T02:05:01.703Z",
  "timeLastMod": "2025-04-06T02:05:01.703Z",
  "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"
        }
      ]
    }
  },
  "authMode": [
    "0 = MandatoryForAllUsers",
    "1 = CreateTokenForDomainAuthenticatedUsers",
    "2 = UsersWithSafeNetAcc"
  ],
  "otpServiceURL": "text",
  "userRepository": "text",
  "tmsWebApiURL": "text"
}

Created

Update

put

Update the MFA Safenet settings.

Path parameters

idinteger · int32required

The id for which to modify the MFA settings.

Body

Update MFA of type safenet

namestring | 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.