PATCH
/
action_configurations
/
{action_code}
/
rules
/
{rule_id}
curl --request PATCH \
  --url https://api.authsignal.com/v1/management/action_configurations/{action_code}/rules/{rule_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "isActive": true,
  "priority": 49,
  "type": "ALLOW",
  "conditions": {},
  "verificationMethods": [
    "SMS"
  ],
  "promptToEnrollVerificationMethods": [
    "PASSKEY"
  ],
  "defaultVerificationMethod": "SMS"
}'
{
  "name": "<string>",
  "description": "<string>",
  "isActive": true,
  "priority": 49,
  "tenantId": "<string>",
  "ruleId": "<string>",
  "type": "ALLOW",
  "conditions": {},
  "verificationMethods": [
    "SMS"
  ],
  "promptToEnrollVerificationMethods": [
    "PASSKEY"
  ],
  "defaultVerificationMethod": "SMS"
}

Path Parameters

​
action_code
string
required

The action code used to identify the action configuration.

​
rule_id
string
required

The unique id of the rule which can be obtained when creating a rule or from the admin portal.

Body

application/json
​
name
string
​
description
string
​
isActive
boolean
​
priority
integer
Required range: 0 <= x <= 99
​
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

Response

200
application/json
OK
​
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?

Get RuleDelete Rule