Adaptive Authentication Realm Settings Endpoint

ipCountrySetting

Settings for IP / country restrictions

userGroupSetting

Settings for user / group restrictions

ipReputationThreatData

Settings for IP reputation threat data restrictions

geoVelocity

Settings for geo-velocity restrictions

userRisk

Settings for user risk restrictions

analyzeOrder

Order of restrictions to be analyzed per login

Accepted values, if enabled, in prioritized order:

enabled

Enable Adaptive Authentication criterion

restrictionType

Information used for restriction

inListAction

Create list of selected restrictionType that is allowed or denied access to realm

ipCountryList

List of allowed or denied IP addresses or countries based on restrictionType and inListAction values

Country codes must be listed in two-letter ISO format

failureAction

Action to take when login meets restriction criteria

failureActionRedirect

URL to which end-users are redirected if login meets restrictions

URL path

For "FailureAction": "Redirect" configurations

requireUsernameBeforeAdaptive

Initiate IP / country and / or IP reputation analysis after end-user provides username

userGroupList

List of allowed or denied IP addresses or countries based on restrictionType and inListAction values

any

extremeRiskAction

Action to take when login presents extreme risk

extremeRiskRedirect

URL to which end-users are redirected if login presents extreme risk

URL path

For "extremeRiskAction": "Redirect" configurations

highRiskAction

Action to take when login presents high risk

highRiskRedirect

URL to which end-users are redirected if login presents high risk

URL path

For "highRiskAction": "Redirect" configurations

mediumRiskAction

Action to take when login presents medium risk

mediumRiskRedirect

URL to which end-users are redirected if login presents medium risk

URL path

For "mediumRiskAction": "Redirect" configurations

lowRiskAction

Action to take when login presents low risk

lowRiskRedirect

URL to which end-users are redirected if login presents low risk

URL path

For "lowRiskAction": "Redirect" configurations

ipWhiteList

List of IP addresses that bypass the IP reputation threat data analysis

velocityLimit

Maximum speed in mph end-users could have traveled between last successful login and current login attempt

any, numerical

noScoreAction

Action to take when login presents no score

noScoreRedirect

URL to which end-users are redirected if login presents no score

URL path

For "noScoreAction": "Redirect" configurations

providers

Entity supplying the User Risk Score

any

name

Friendly name for the User Risk Score provider

any

baseUrl

Root URL of the data server containing user profile information

Consistent portion of web address to which all endpoints are relative

profileRelativeUrl

API endpoint relative URL path used to retrieve user profile information

Relative URL path should include /{username}

authenticationMethod

How the connection is secured

Basic HTTP header is generated, containing the authentication credentials (username, password)

username

Valid service account on the datastore that has permission to access and retrieve user profile information

any

password

Password associated with the Username

any

cookieUrl

API endpoint containing the relative URL path used in the authentication connection

Applicable to "authenticationMethod": "[cookie]" (actual parameter name / format depends on authenticationMethod list)

requestIdField

Profile Property mapped to the directory attribute that contains the user’s ID required by the User Risk Score provider

riskScoreJsonPath

Profile Field containing the User Risk Score JSON path

{xxx}{riskScore}

rangeMax

Highest score a user can receive from User Risk Score provider

any, default 100

rangeMin

Lowest score a user can receive from User Risk Score provider

any, default 0

highRisk

Threshold for high risk user scores, i.e. a score from this numerical value to rangeMax is considered high risk

any, default 90

mediumRisk

Threshold for medium risk user scores, i.e. a score from this numerical value to highRisk is considered medium risk

any, default 75

deleteProvider

Remove User Risk Score provider from the system

{
        "ipCountrySetting": {
                "enabled": true,
                "restrictionType": "ip",
                "inListAction": "Allow",
                "ipCountryList": [<IP ADDRESS LIST>],
                "failureAction": "HardStop",
                "failureActionRedirect": null,
                "requireUsernameBeforeAdaptive": false
        },
        "userGroupSetting": {
                "enabled": true,
                "restrictionType": "user",
                "inListAction": "Deny",
                "userGroupList": [<USER LIST>],
                "failureAction": "TwoFactor",
                "failureActionRedirect": null
        },
        "ipReputationThreatData": {
                "enabled": true,
                "extremeRiskAction": "HardStop",
                "extremeRiskRedirect": null,
                "highRiskAction": "TwoFactor",
                "highRiskRedirect": null,
                "mediumRiskAction": "Redirect",
                "mediumRiskRedirect": "https://url.com",
                "lowRiskAction": "Continue",
                "lowRiskRedirect": null,
                "ipWhitelist": [<IP LIST>],
                "requireUsernameBeforeAdaptiveAuth": true
        },
        "geoVelocity": {
                "enabled": true,
                "velocityLimit": 500,
                "failureAction": "HardStop",
                "failureActionRedirect": null
        },
    "userRisk": {
        "enabled": true,
        "providers": [
          {
            "enabled": true,
            "name": "",
            "baseUrl": "",
            "profileRelativeUrl": "",
            "authenticationMethod": "",
            "username": "",
            "password": "",
            "cookieUrl": "",
            "requestIdField": "",
            "riskScoreJsonPath": "",
            "rangeMax": 100,
            "rangeMin": 0,
            "highRisk": 90,
            "mediumRisk": 75,
            "deleteProvider": false
          }
        ],
        "highRiskAction": "HardStop",
        "highRiskRedirect": null,
        "mediumRiskAction": "TwoFactor",
        "mediumRiskRedirect": null,
        "lowRiskAction": "Continue",
        "lowRiskRedirect": null,
        "noScoreAction": "Disable",
        "noScoreRedirect": null
    }
        "analyzeOrder": [
                "IpCountry"
                "IpReputationThreatData"
                "UserGroup"
                "GeoVelocity"
                "UserRisk"
        ]
}

{
 "status": "Success",
 "message": []
}