Duplicate

Duplicate a Multi Factor Authentication.

POST/api/MFA/{id}/Duplicate

Path parameters

id*integer (int32)

The ID of the Multi Factor Authentication to duplicate

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.

Request

Response

Duplicate

Duplicate a Multi Factor Authentication.

POST/api/MFA/{id}/Duplicate

Path parameters

id*integer (int32)

The ID of the Multi Factor Authentication to duplicate

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.

Request

Response

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:16:41.828Z",
  "timeLastMod": "2024-11-07T10:16:41.828Z",
  "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"
        }
      ]
    }
  }
}