Safenet

Create

Create a new Safenet MFA.

POST/api/MFA/Safenet

Body

application/json; api-version=1.0

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.

safenetAuthModeSafeNetAuthMode (enum)

SafeNet Authentication Mode

0 = MandatoryForAllUsers,1 = CreateTokenForDomainAuthenticatedUsers,2 = UsersWithSafeNetAcc

otpServiceURL*nullable string

OTP Service URL

userRepositorynullable string

A value representing User Store

tmsWebApiURLnullable string

The URL of the web service

Response

201401409

Created

Body

application/json; api-version=1.0

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

authModeSafeNetAuthMode (enum)

SafeNet Authentication Mode

0 = MandatoryForAllUsers,1 = CreateTokenForDomainAuthenticatedUsers,2 = UsersWithSafeNetAcc

otpServiceURLnullable string

OTP Service URL

userRepositorynullable string

A value representing User Store

tmsWebApiURLnullable string

The URL of the web service

Request

JavaScriptCurlPython

const response = await fetch('/api/MFA/Safenet', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "name": "text",
      "otpServiceURL": "text"
    }),
});
const data = await response.json();

Response

201401409

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T14:13:22.408Z",
  "timeLastMod": "2024-12-21T14:13:22.408Z",
  "name": "text",
  "siteId": 0,
  "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"
        }
      ]
    }
  },
  "authMode": [
    "0 = MandatoryForAllUsers",
    "1 = CreateTokenForDomainAuthenticatedUsers",
    "2 = UsersWithSafeNetAcc"
  ],
  "otpServiceURL": "text",
  "userRepository": "text",
  "tmsWebApiURL": "text"
}

Update

Update the MFA Safenet settings.

PUT/api/MFA/Safenet/{id}

Path parameters

id*integer (int32)

The id for which to modify the MFA settings.

Body

application/json; api-version=1.0

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

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/MFA/Safenet/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}