All pages
Powered by GitBook
1 of 7

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Devices

Criteria

IPs

Hardware IDs

Gateway IPs

Security Principals

OSes

List

get

Retrieve Criteria Device List of a Site Defaults object.

Query parameters
siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).

Responses
200

Success

application/json; api-version=1.0
401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
get
/api/MFADefaultSettings/Criteria/Devices

Add

post

Add a device to the Device List of the Criteria settings.

Query parameters
siteIdinteger · int32Optional

The Site ID of an object for which to modify the Criteria settings (optional).

Body

Add a client device to the Criteria Devices list

clientDeviceNamestring | nullableRequired

The name of the client device to add to the Criteria.

Responses
201

Created

401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
409

Conflict

application/json; api-version=1.0
post
/api/MFADefaultSettings/Criteria/Devices

No content

Remove

delete

Remove a device from the Device List of the Criteria settings.

Query parameters
siteIdinteger · int32Optional

The Site ID of an object for which to modify the Criteria settings (optional).

Body

Remove a client device from the Criteria Devices list

clientDeviceNamestring | nullableRequired

The name of the client device to remove from the Criteria.

Responses
204

No Content

401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
delete
/api/MFADefaultSettings/Criteria/Devices

No content

Get

get

Retrieve the Criteria settings of a MFA Default object.

Query parameters
siteIdinteger · int32Optional

The SiteId of a MFA Default object for which to retrieve the Criteria settings (optional).

Responses
200

Success

application/json; api-version=1.0
401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
get
/api/MFADefaultSettings/Criteria

Update

put

Update the Criteria settings of a MFA Default object.

Query parameters
siteIdinteger · int32Optional

The SiteId of a MFA Default object for which to modify the Criteria settings (optional).

Body
accessstring · enumOptional

Access type options

Possible values:
securityPrincipalsEnabledboolean | nullableOptional

Whether the Security Principals criteria is enabled or not

securityPrincipalsMatchingModestring · enumOptional

Matching mode type options

Possible values:
gatewaysEnabledboolean | nullableOptional

Whether the Gateways criteria is enabled or not

gatewaysMatchingModestring · enumOptional

Matching mode type options

Possible values:
devicesEnabledboolean | nullableOptional

Whether the Devices criteria is enabled or not

devicesMatchingModestring · enumOptional

Matching mode type options

Possible values:
oSsEnabledboolean | nullableOptional

Whether the OSs criteria is enabled or not

oSsMatchingModestring · enumOptional

Matching mode type options

Possible values:
iPsEnabledboolean | nullableOptional

Whether the IPs criteria is enabled or not

iPsMatchingModestring · enumOptional

Matching mode type options

Possible values:
hardwareIDsEnabledboolean | nullableOptional

Whether the HardwareIDs criteria is enabled or not

hardwareIDsMatchingModestring · enumOptional

Matching mode type options

Possible values:
Responses
204

No Content

401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
put
/api/MFADefaultSettings/Criteria

List

get

Retrieve Criteria IP List of a Site Defaults object.

Query parameters
siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).

Responses
200

Success

application/json; api-version=1.0
401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
get
/api/MFADefaultSettings/Criteria/IPs

Add

post

Add an IP to the IP List of the Criteria settings.

Query parameters
siteIdinteger · int32Optional

The Site ID of an object for which to modify the Criteria settings (optional).

Body

Add an IP to the Criteria IP list

ipstring | nullableRequired

Value that represents the IP

ipTypestring · enumRequired

IP Version

Possible values:
Responses
201

Created

401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
409

Conflict

application/json; api-version=1.0
post
/api/MFADefaultSettings/Criteria/IPs

No content

Remove

delete

Remove an IP from the IP List of the Criteria settings.

Query parameters
siteIdinteger · int32Optional

The Site ID of an object for which to modify the Criteria settings (optional).

Body

Remove an IP from the Criteria IP list

ipstring | nullableRequired

Value that represents the IP

ipTypestring · enumRequired

IP Version

Possible values:
Responses
204

No Content

401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
delete
/api/MFADefaultSettings/Criteria/IPs

No content

List

get

Retrieve Criteria Hardware ID List of a Site Defaults object.

Query parameters
siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).

Responses
200

Success

application/json; api-version=1.0
401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
get
/api/MFADefaultSettings/Criteria/HardwareIDs

Add

post

Add a hardware ID to the Hardware ID List of the Criteria settings.

Query parameters
siteIdinteger · int32Optional

The Site ID of an object for which to modify the Criteria settings (optional).

Body

Add a hardware ID to the Criteria Hardware ID list

hardwareIDstring | nullableRequired

The hardware ID to add to the Criteria.

Responses
201

Created

401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
409

Conflict

application/json; api-version=1.0
post
/api/MFADefaultSettings/Criteria/HardwareIDs

No content

Remove

delete

Remove a hardware ID from the Hardware ID List of the Criteria settings.

Query parameters
siteIdinteger · int32Optional

The Site ID of an object for which to modify the Criteria settings (optional).

Body

Remove a hardware ID from the Criteria Hardware ID list

hardwareIDstring | nullableRequired

The hardware ID to remove from the Criteria.

Responses
204

No Content

401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
delete
/api/MFADefaultSettings/Criteria/HardwareIDs

No content

List

get

Retrieve Criteria Gateway IP List of a Site Defaults object.

Query parameters
siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).

Responses
200

Success

application/json; api-version=1.0
401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
get
/api/MFADefaultSettings/Criteria/GatewayIPs

Add

post

Add a gateway IP to the Gateway IP List of the Criteria settings.

Query parameters
siteIdinteger · int32Optional

The Site ID of an object for which to modify the Criteria settings (optional).

Body

Add a gateway IP to the Criteria Gateways list

ipstring | nullableOptional

The IP of the gateway to add to the Criteria.

gatewayIdinteger · int32 | nullableOptional

The ID of the gateway to add to the Criteria.

Responses
201

Created

401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
409

Conflict

application/json; api-version=1.0
post
/api/MFADefaultSettings/Criteria/GatewayIPs

No content

Remove

delete

Remove a gateway IP from the Gateway IP List of the Criteria settings.

Query parameters
siteIdinteger · int32Optional

The Site ID of an object for which to modify the Criteria settings (optional).

Body

Remove a gateway IP from the Criteria Gateways list

ipstring | nullableRequired

The IP of the gateway to remove from the Criteria.

Responses
204

No Content

401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
delete
/api/MFADefaultSettings/Criteria/GatewayIPs

No content

List

get

Retrieve Criteria Security Principal List of a Site Defaults object.

Query parameters
siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).

Responses
200

Success

application/json; api-version=1.0
401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
get
/api/MFADefaultSettings/Criteria/SecurityPrincipals

Add

post

Add a user, group or machine to the Security Principal List of the Criteria settings.

Query parameters
siteIdinteger · int32Optional

The Site ID of an object for which to modify the Criteria settings (optional).

Body

Add a user, group or machine account to the Criteria security principal list

accountstring | nullableOptional

The name of the account to add to the Criteria.

sidstring | nullableOptional

The SID of the account to add to the Criteria.

Responses
201

Created

401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
409

Conflict

application/json; api-version=1.0
post
/api/MFADefaultSettings/Criteria/SecurityPrincipals

No content

Remove

delete

Remove a user, group or machine from the Security Principal List of the Criteria settings.

Query parameters
siteIdinteger · int32Optional

The Site ID of an object for which to modify the Criteria settings (optional).

Body

Remove a user, group or machine from the Criteria security principal list

accountstring | nullableOptional

The name of the account to remove from the Criteria.

sidstring | nullableOptional

The SID of the account to remove from the Criteria.

Responses
204

No Content

401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
delete
/api/MFADefaultSettings/Criteria/SecurityPrincipals

No content

Get

get

Retrieve Criteria OS of a Site Defaults object.

Query parameters
siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).

Responses
200

Success

application/json; api-version=1.0
401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
get
/api/MFADefaultSettings/Criteria/OSes

Update

put

Modify the OS of the Criteria settings.

Query parameters
siteIdinteger · int32Optional

The Site ID of an object for which to modify the Criteria settings (optional).

Body
allowClientChromeboolean | nullableOptional

Allow Chrome OS clients.

allowClientAndroidboolean | nullableOptional

Allow Android clients.

allowClientWebboolean | nullableOptional

Allow Web clients.

allowClientIOSboolean | nullableOptional

Allow IOS clients.

allowClientLinuxboolean | nullableOptional

Allow Linux clients.

allowClientMACboolean | nullableOptional

Allow Mac clients.

allowClientWindowsboolean | nullableOptional

Allow Windows clients.

allowClientWyseboolean | nullableOptional

Allow Wyse clients.

Responses
204

No Content

401

Unauthorized

application/json; api-version=1.0
404

Not Found

application/json; api-version=1.0
put
/api/MFADefaultSettings/Criteria/OSes

No content

No content

GET /api/MFADefaultSettings/Criteria/Devices HTTP/1.1
Host: 
Accept: */*
[
  {
    "client": "text"
  }
]
POST /api/MFADefaultSettings/Criteria/Devices HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 27

{
  "clientDeviceName": "text"
}
DELETE /api/MFADefaultSettings/Criteria/Devices HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 27

{
  "clientDeviceName": "text"
}
GET /api/MFADefaultSettings/Criteria HTTP/1.1
Host: 
Accept: */*
{
  "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"
      }
    ]
  }
}
PUT /api/MFADefaultSettings/Criteria HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 681

{
  "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"
  ]
}
GET /api/MFADefaultSettings/Criteria/IPs HTTP/1.1
Host: 
Accept: */*
{
  "iPv4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "iPv6s": [
    {
      "from": "text",
      "to": "text"
    }
  ]
}
POST /api/MFADefaultSettings/Criteria/IPs HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 73

{
  "ip": "text",
  "ipType": [
    "0 = Version4",
    "1 = Version6",
    "2 = BothVersions"
  ]
}
DELETE /api/MFADefaultSettings/Criteria/IPs HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 73

{
  "ip": "text",
  "ipType": [
    "0 = Version4",
    "1 = Version6",
    "2 = BothVersions"
  ]
}
GET /api/MFADefaultSettings/Criteria/HardwareIDs HTTP/1.1
Host: 
Accept: */*
[
  {
    "hardwareID": "text"
  }
]
POST /api/MFADefaultSettings/Criteria/HardwareIDs HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 21

{
  "hardwareID": "text"
}
DELETE /api/MFADefaultSettings/Criteria/HardwareIDs HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 21

{
  "hardwareID": "text"
}
GET /api/MFADefaultSettings/Criteria/GatewayIPs HTTP/1.1
Host: 
Accept: */*
[
  {
    "gatewayIP": "text"
  }
]
POST /api/MFADefaultSettings/Criteria/GatewayIPs HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 27

{
  "ip": "text",
  "gatewayId": 1
}
DELETE /api/MFADefaultSettings/Criteria/GatewayIPs HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 13

{
  "ip": "text"
}
GET /api/MFADefaultSettings/Criteria/SecurityPrincipals HTTP/1.1
Host: 
Accept: */*
[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text"
  }
]
POST /api/MFADefaultSettings/Criteria/SecurityPrincipals HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}
DELETE /api/MFADefaultSettings/Criteria/SecurityPrincipals HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}
GET /api/MFADefaultSettings/Criteria/OSes HTTP/1.1
Host: 
Accept: */*
{
  "chrome": true,
  "android": true,
  "webClient": true,
  "iOS": true,
  "linux": true,
  "mac": true,
  "wyse": true,
  "windows": true
}
PUT /api/MFADefaultSettings/Criteria/OSes HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 191

{
  "allowClientChrome": true,
  "allowClientAndroid": true,
  "allowClientWeb": true,
  "allowClientIOS": true,
  "allowClientLinux": true,
  "allowClientMAC": true,
  "allowClientWindows": true,
  "allowClientWyse": true
}