View the current Risk Model.

Prev Next
Get
Deprecated
/risk-model

View the current Risk Model. Deprecated as of 6.5. Please use Conditions instead.

Security
HTTP
Type bearer
Responses
200

Risk Model.

Expand All
object
ztpRuleId
string

ID of the rule in ZTP to use as the source of the risk score.

lowSensitivity
object (Sensitivity)

Sensitivity settings.

lowRisk
object (Risk)

Risk definition.

action
string

The action to take for the risk level.

Valid values[ "Allow", "Deny", "AllowWithUserAction" ]
Default"Allow"
denyMessage
string

Enter to show a Display Message User Action to the user when the action is Deny.

userAction
object
type
string

User Action type. May not be DisplayMessage or Reason for Risk Access.

Valid values[ "OtpAuthentication", "PasswordAuthentication" ]
message
string

Message to be shown to the user. Required for all remedy method.

ExampleThis resource requires you to enter your password again
claimSuffix
string

Suffix to be added to the claim. Required for OtpAuthentication, PasswordAuthentication and Reason remedy methods.

Exampletest
providerId
string (uuid)

MFA Provider Id or Identity Provider Id. Required for some remedy method.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
mediumRisk
object (Risk)

Risk definition.

action
string

The action to take for the risk level.

Valid values[ "Allow", "Deny", "AllowWithUserAction" ]
Default"Allow"
denyMessage
string

Enter to show a Display Message User Action to the user when the action is Deny.

userAction
object
type
string

User Action type. May not be DisplayMessage or Reason for Risk Access.

Valid values[ "OtpAuthentication", "PasswordAuthentication" ]
message
string

Message to be shown to the user. Required for all remedy method.

ExampleThis resource requires you to enter your password again
claimSuffix
string

Suffix to be added to the claim. Required for OtpAuthentication, PasswordAuthentication and Reason remedy methods.

Exampletest
providerId
string (uuid)

MFA Provider Id or Identity Provider Id. Required for some remedy method.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
highRisk
object (Risk)

Risk definition.

action
string

The action to take for the risk level.

Valid values[ "Allow", "Deny", "AllowWithUserAction" ]
Default"Allow"
denyMessage
string

Enter to show a Display Message User Action to the user when the action is Deny.

userAction
object
type
string

User Action type. May not be DisplayMessage or Reason for Risk Access.

Valid values[ "OtpAuthentication", "PasswordAuthentication" ]
message
string

Message to be shown to the user. Required for all remedy method.

ExampleThis resource requires you to enter your password again
claimSuffix
string

Suffix to be added to the claim. Required for OtpAuthentication, PasswordAuthentication and Reason remedy methods.

Exampletest
providerId
string (uuid)

MFA Provider Id or Identity Provider Id. Required for some remedy method.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
mediumSensitivity
object (Sensitivity)

Sensitivity settings.

lowRisk
object (Risk)

Risk definition.

action
string

The action to take for the risk level.

Valid values[ "Allow", "Deny", "AllowWithUserAction" ]
Default"Allow"
denyMessage
string

Enter to show a Display Message User Action to the user when the action is Deny.

userAction
object
type
string

User Action type. May not be DisplayMessage or Reason for Risk Access.

Valid values[ "OtpAuthentication", "PasswordAuthentication" ]
message
string

Message to be shown to the user. Required for all remedy method.

ExampleThis resource requires you to enter your password again
claimSuffix
string

Suffix to be added to the claim. Required for OtpAuthentication, PasswordAuthentication and Reason remedy methods.

Exampletest
providerId
string (uuid)

MFA Provider Id or Identity Provider Id. Required for some remedy method.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
mediumRisk
object (Risk)

Risk definition.

action
string

The action to take for the risk level.

Valid values[ "Allow", "Deny", "AllowWithUserAction" ]
Default"Allow"
denyMessage
string

Enter to show a Display Message User Action to the user when the action is Deny.

userAction
object
type
string

User Action type. May not be DisplayMessage or Reason for Risk Access.

Valid values[ "OtpAuthentication", "PasswordAuthentication" ]
message
string

Message to be shown to the user. Required for all remedy method.

ExampleThis resource requires you to enter your password again
claimSuffix
string

Suffix to be added to the claim. Required for OtpAuthentication, PasswordAuthentication and Reason remedy methods.

Exampletest
providerId
string (uuid)

MFA Provider Id or Identity Provider Id. Required for some remedy method.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
highRisk
object (Risk)

Risk definition.

action
string

The action to take for the risk level.

Valid values[ "Allow", "Deny", "AllowWithUserAction" ]
Default"Allow"
denyMessage
string

Enter to show a Display Message User Action to the user when the action is Deny.

userAction
object
type
string

User Action type. May not be DisplayMessage or Reason for Risk Access.

Valid values[ "OtpAuthentication", "PasswordAuthentication" ]
message
string

Message to be shown to the user. Required for all remedy method.

ExampleThis resource requires you to enter your password again
claimSuffix
string

Suffix to be added to the claim. Required for OtpAuthentication, PasswordAuthentication and Reason remedy methods.

Exampletest
providerId
string (uuid)

MFA Provider Id or Identity Provider Id. Required for some remedy method.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
highSensitivity
object (Sensitivity)

Sensitivity settings.

lowRisk
object (Risk)

Risk definition.

action
string

The action to take for the risk level.

Valid values[ "Allow", "Deny", "AllowWithUserAction" ]
Default"Allow"
denyMessage
string

Enter to show a Display Message User Action to the user when the action is Deny.

userAction
object
type
string

User Action type. May not be DisplayMessage or Reason for Risk Access.

Valid values[ "OtpAuthentication", "PasswordAuthentication" ]
message
string

Message to be shown to the user. Required for all remedy method.

ExampleThis resource requires you to enter your password again
claimSuffix
string

Suffix to be added to the claim. Required for OtpAuthentication, PasswordAuthentication and Reason remedy methods.

Exampletest
providerId
string (uuid)

MFA Provider Id or Identity Provider Id. Required for some remedy method.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
mediumRisk
object (Risk)

Risk definition.

action
string

The action to take for the risk level.

Valid values[ "Allow", "Deny", "AllowWithUserAction" ]
Default"Allow"
denyMessage
string

Enter to show a Display Message User Action to the user when the action is Deny.

userAction
object
type
string

User Action type. May not be DisplayMessage or Reason for Risk Access.

Valid values[ "OtpAuthentication", "PasswordAuthentication" ]
message
string

Message to be shown to the user. Required for all remedy method.

ExampleThis resource requires you to enter your password again
claimSuffix
string

Suffix to be added to the claim. Required for OtpAuthentication, PasswordAuthentication and Reason remedy methods.

Exampletest
providerId
string (uuid)

MFA Provider Id or Identity Provider Id. Required for some remedy method.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
highRisk
object (Risk)

Risk definition.

action
string

The action to take for the risk level.

Valid values[ "Allow", "Deny", "AllowWithUserAction" ]
Default"Allow"
denyMessage
string

Enter to show a Display Message User Action to the user when the action is Deny.

userAction
object
type
string

User Action type. May not be DisplayMessage or Reason for Risk Access.

Valid values[ "OtpAuthentication", "PasswordAuthentication" ]
message
string

Message to be shown to the user. Required for all remedy method.

ExampleThis resource requires you to enter your password again
claimSuffix
string

Suffix to be added to the claim. Required for OtpAuthentication, PasswordAuthentication and Reason remedy methods.

Exampletest
providerId
string (uuid)

MFA Provider Id or Identity Provider Id. Required for some remedy method.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
401

Token error. Login again.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

500

Unexpected server side error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.