Criteria | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieve the Criteria settings of an MFA with the specified ID.

Path parameters

idinteger · int32required

The ID of an MFA for which to retrieve the Criteria settings.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/MFA/{id}/Criteria'

200

401

404

{
  "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"
      }
    ]
  }
}

Success

Update

put

Update the Criteria settings of an MFA with the specified ID.

Path parameters

idinteger · int32required

The ID of an MFA for which to modify the Criteria settings.

Body

accessstring · enumoptional

Access type options

Available options:

securityPrincipalsEnabledboolean | nullableoptional

Whether the Security Principals criteria is enabled or not

securityPrincipalsMatchingModestring · enumoptional

Matching mode type options

Available options:

gatewaysEnabledboolean | nullableoptional

Whether the Gateways criteria is enabled or not

gatewaysMatchingModestring · enumoptional

Matching mode type options

Available options:

devicesEnabledboolean | nullableoptional

Whether the Devices criteria is enabled or not

devicesMatchingModestring · enumoptional

Matching mode type options

Available options:

oSsEnabledboolean | nullableoptional

Whether the OSs criteria is enabled or not

oSsMatchingModestring · enumoptional

Matching mode type options

Available options:

iPsEnabledboolean | nullableoptional

Whether the IPs criteria is enabled or not

iPsMatchingModestring · enumoptional

Matching mode type options

Available options:

hardwareIDsEnabledboolean | nullableoptional

Whether the HardwareIDs criteria is enabled or not

hardwareIDsMatchingModestring · enumoptional

Matching mode type options

Available options:

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/MFA/{id}/Criteria' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "access": [
      "0 = DenyCriteriaWhen",
      "1 = AllowCriteriaWhen"
    ],
    "securityPrincipalsEnabled": true,
    "securityPrincipalsMatchingMode": [
      "0 = IsNotOneOfTheFollowing",
      "1 = IsOneOfTheFollowing"
    ],
    "gatewaysEnabled": true,
    "gatewaysMatchingMode": [
      "0 = IsNotOneOfTheFollowing",
      "1 = IsOneOfTheFollowing"
    ],
    "devicesEnabled": true,
    "devicesMatchingMode": [
      "0 = IsNotOneOfTheFollowing",
      "1 = IsOneOfTheFollowing"
    ],
    "oSsEnabled": true,
    "oSsMatchingMode": [
      "0 = IsNotOneOfTheFollowing",
      "1 = IsOneOfTheFollowing"
    ],
    "iPsEnabled": true,
    "iPsMatchingMode": [
      "0 = IsNotOneOfTheFollowing",
      "1 = IsOneOfTheFollowing"
    ],
    "hardwareIDsEnabled": true,
    "hardwareIDsMatchingMode": [
      "0 = IsNotOneOfTheFollowing",
      "1 = IsOneOfTheFollowing"
    ]
  }'

204

401

404

No Content