Auth0 · Schema

CreateRuleRequestContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
name	string	Name of this rule.
script	string	Code to be executed when this rule runs.
order	number	Order that this rule should execute in relative to other rules. Lower-valued rules execute first.
enabled	boolean	Whether the rule is enabled (true), or disabled (false).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateRuleRequestContent",
  "title": "CreateRuleRequestContent",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name",
    "script"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of this rule.",
      "default": "my-rule",
      "pattern": "^[a-zA-Z0-9]([ \\-a-zA-Z0-9]*[a-zA-Z0-9])?$"
    },
    "script": {
      "type": "string",
      "description": "Code to be executed when this rule runs.",
      "default": "function (user, context, callback) {\n  callback(null, user, context);\n}",
      "minLength": 1
    },
    "order": {
      "type": "number",
      "description": "Order that this rule should execute in relative to other rules. Lower-valued rules execute first.",
      "default": 2,
      "minimum": 0
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the rule is enabled (true), or disabled (false).",
      "default": true
    }
  }
}