Stytch · Schema

api_fraud_v1_Rule

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name	Type	Description
rule_type	object	The rule type. The possible values are `VISITOR_ID`, `BROWSER_ID`, `VISITOR_FINGERPRINT`, `BROWSER_FINGERPRINT`, `HARDWARE_FINGERPRINT`, `NETWORK_FINGERPRINT`, `CIDR_BLOCK`, `ASN`, or `COUNTRY_CODE`.
action	object	The action (`ALLOW`, `BLOCK`, or `CHALLENGE`) that will be returned for this rule.
created_at	string	The time when the rule was created. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.
visitor_id	string	The visitor ID that a rule was set for.
browser_id	string	The browser ID that a rule was set for.
visitor_fingerprint	string	The visitor fingerprint that a rule was set for.
browser_fingerprint	string	The browser fingerprint that a rule was set for.
hardware_fingerprint	string	The hardware fingerprint that a rule was set for.
network_fingerprint	string	The network fingerprint that a rule was set for.
cidr_block	string	The CIDR block that a rule was set for. If an end user's IP address is within this CIDR block, this rule will be applied.
country_code	string	The country code that a rule was set for.
asn	string	The ASN that a rule was set for.
description	string	A description for the rule.
expires_at	string	The timestamp when the rule expires. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.
last_updated_at	string	The time when the rule was last updated. Will be null if the rule has never been updated. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_fraud_v1_Rule",
  "title": "api_fraud_v1_Rule",
  "type": "object",
  "properties": {
    "rule_type": {
      "$ref": "#/components/schemas/api_fraud_v1_RuleType",
      "description": "The rule type. The possible values are `VISITOR_ID`, `BROWSER_ID`, `VISITOR_FINGERPRINT`, `BROWSER_FINGERPRINT`, `HARDWARE_FINGERPRINT`, `NETWORK_FINGERPRINT`, `CIDR_BLOCK`, `ASN`, or `COUNTRY_CODE`."
    },
    "action": {
      "$ref": "#/components/schemas/api_fraud_v1_RuleAction",
      "description": "The action (`ALLOW`, `BLOCK`, or `CHALLENGE`) that will be returned for this rule."
    },
    "created_at": {
      "type": "string",
      "description": "The time when the rule was created. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`."
    },
    "visitor_id": {
      "type": "string",
      "description": "The visitor ID that a rule was set for."
    },
    "browser_id": {
      "type": "string",
      "description": "The browser ID that a rule was set for."
    },
    "visitor_fingerprint": {
      "type": "string",
      "description": "The visitor fingerprint that a rule was set for."
    },
    "browser_fingerprint": {
      "type": "string",
      "description": "The browser fingerprint that a rule was set for."
    },
    "hardware_fingerprint": {
      "type": "string",
      "description": "The hardware fingerprint that a rule was set for."
    },
    "network_fingerprint": {
      "type": "string",
      "description": "The network fingerprint that a rule was set for."
    },
    "cidr_block": {
      "type": "string",
      "description": "The CIDR block that a rule was set for. If an end user's IP address is within this CIDR block, this rule will be applied."
    },
    "country_code": {
      "type": "string",
      "description": "The country code that a rule was set for."
    },
    "asn": {
      "type": "string",
      "description": "The ASN that a rule was set for."
    },
    "description": {
      "type": "string",
      "description": "A description for the rule."
    },
    "expires_at": {
      "type": "string",
      "description": "The timestamp when the rule expires. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`."
    },
    "last_updated_at": {
      "type": "string",
      "description": "The time when the rule was last updated. Will be null if the rule has never been updated. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`."
    }
  },
  "required": [
    "rule_type",
    "action",
    "created_at"
  ]
}