Rules
Get Rule
Gets a rule by action code and rule ID.
GET
/
action_configurations
/
{action_code}
/
rules
/
{rule_id}
Path Parameters
action_code
string
requiredThe action code used to identify the action configuration.
rule_id
string
requiredThe unique id of the rule which can be obtained when creating a rule, or from the admin portal.
Response
200 - application/json
name
string
description
string
isActive
boolean
priority
integer
Required range:
0 < x < 99
tenantId
string
ruleId
string
type
enum<string>
Available options:
ALLOW
, BLOCK
, CHALLENGE
, REVIEW
conditions
object
verificationMethods
enum<string>[]
Available options:
SMS
, AUTHENTICATOR_APP
, RECOVERY_CODE
, EMAIL_MAGIC_LINK
, EMAIL_OTP
, PUSH
, SECURITY_KEY
, PASSKEY
, VERIFF
, IPROOV
, PALM_BIOMETRICS_RR
promptToEnrollVerificationMethods
enum<string>[]
Available options:
PASSKEY
defaultVerificationMethod
enum<string>
Available options:
SMS
, AUTHENTICATOR_APP
, RECOVERY_CODE
, EMAIL_MAGIC_LINK
, EMAIL_OTP
, PUSH
, SECURITY_KEY
, PASSKEY
, VERIFF
, IPROOV
, PALM_BIOMETRICS_RR
Was this page helpful?