Skip to main content
POST
/
action_configurations
/
{action_code}
/
rules
Create Rule
curl --request POST \
  --url https://api.authsignal.com/v1/management/action_configurations/{action_code}/rules \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "isActive": true,
  "priority": 49,
  "type": "ALLOW",
  "conditions": {},
  "description": "<string>",
  "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"
}

Authorizations

​
Authorization
string
header
required

Use your Authsignal Management API secret key as the username and leave the password empty. This key is different from the Server API key and can be found in the API Keys section of the Authsignal Portal settings page.

Path Parameters

​
action_code
string
required

The action code used to identify the action configuration.

Body

application/json
​
name
string
required
​
isActive
boolean
required
​
priority
integer
required
Required range: 0 <= x <= 99
​
type
enum<string>
required
Available options:
ALLOW,
BLOCK,
CHALLENGE,
REVIEW
​
conditions
object
required
​
description
string
​
verificationMethods
enum<string>[]
Available options:
SMS,
AUTHENTICATOR_APP,
RECOVERY_CODE,
EMAIL_MAGIC_LINK,
EMAIL_OTP,
PUSH,
DEVICE,
SECURITY_KEY,
PASSKEY,
VERIFF,
IPROOV,
PALM_BIOMETRICS_RR
​
promptToEnrollVerificationMethods
enum<string>[]
Available options:
PASSKEY
​
defaultVerificationMethod
enum<string>
Available options:
SMS,
AUTHENTICATOR_APP,
RECOVERY_CODE,
UpdateRuleBody"EMAIL_MAGIC_LINK",
EMAIL_OTP,
PUSH,
DEVICE,
SECURITY_KEY,
PASSKEY,
VERIFF,
IPROOV,
PALM_BIOMETRICS_RR

Response

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,
DEVICE,
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,
DEVICE,
SECURITY_KEY,
PASSKEY,
VERIFF,
IPROOV,
PALM_BIOMETRICS_RR