Create rule

Request

Creates a new recommendation rule. Returns the rule_id used to reference the rule in subsequent requests, along with the rule data.

Security

risk_access_token

Bodyapplication/jsonrequired

namestring

Name of the recommendation rule. Must be unique across the tenant. Autogenerated if not provided.

Example:"Block risky countries"

priorityinteger, [ 1 .. 1000 ]required

Priority of the recommendation rule, which determines the order in which rules are evaluated. Rules are evaluated from smallest to biggest priority value and only the first rule to match will apply. Priority value must be unique.

Example:10

recommendationstringrequired

Recommendation type

Enum:"challenge""deny""trust""allow"

enabledboolean

Whether or not the rule will be evaluated.

Default:false

modestringrequired

Allows you to simulate a rule and evaluate its impact before releasing it to production. The simulation occurs each time a recommendation is requested. If a preview rule matches the request (meaning, its priority is higher than all matching rules), the response will include this preview rule and what the recommendation would have been if all rules were in production.

Enum:"preview""production"

typestringrequired

Default type, must be "risk"

Value:"risk"

descriptionstring

Description for the rule

matchersArray of objectsrequired

Contains a set of activity matchers that define the rule matching logic

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/risk/v1/rules \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Block risky countries",
    "priority": 10,
    "recommendation": "challenge",
    "enabled": false,
    "mode": "preview",
    "type": "risk",
    "description": "string",
    "matchers": [
      {
        "ip_cidrs": {
          "op": "ip_in",
          "value": [
            "string"
          ]
        },
        "device_ids": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "device_fingerprints": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "device_public_keys": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "user_ids": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "country_codes": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "browser_names": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "os_versions": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "action_type": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "client_id": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "application_id": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "asn_id": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "organization_name": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "organization_type": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "ip_timezone": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "device_timezone": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "device_platform": {
          "op": "in",
          "value": [
            "string"
          ]
        },
        "user_agent": {
          "op": "contains",
          "value": [
            "string"
          ]
        },
        "location": {
          "op": "contains",
          "value": [
            "string"
          ]
        }
      }
    ]
  }'

Responses

Rules created and stored successfully

Bodyapplication/json

messagestring

rule_idstring, (uuid)

ID of the recommendation rule, used to reference the rule

dataobject

Recommendation rule

Response

{
  "message": "string",
  "rule_id": "728c1541-d6d1-4290-9a53-cdf01dd32d60",
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "Block risky countries",
    "priority": 10,
    "recommendation": "challenge",
    "enabled": false,
    "mode": "preview",
    "type": "risk",
    "description": "string",
    "matchers": [ … ],
    "created_date": "2019-08-24",
    "updated_date": "2019-08-24"
  }
}