Skip to main content
POST
/
rules
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.rules.create({
        name: "name",
        script: "script",
    });
}
main();
{
  "name": "rule_1",
  "id": "con_0000000000000001",
  "enabled": true,
  "script": "function (user, context, callback) {\n  callback(null, user, context);\n}",
  "order": 1,
  "stage": "login_success"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

​
name
string
default:my-rule
required

Name of this rule.

Pattern: ^[a-zA-Z0-9]([ \-a-zA-Z0-9]*[a-zA-Z0-9])?$
​
script
string
default:function (user, context, callback) { callback(null, user, context); }
required

Code to be executed when this rule runs.

Minimum string length: 1
​
order
number
default:2

Order that this rule should execute in relative to other rules. Lower-valued rules execute first.

Required range: x >= 0
​
enabled
boolean
default:true

Whether the rule is enabled (true), or disabled (false).

Response

Rule successfully created.

​
name
string
default:rule_1

Name of this rule.

​
id
string
default:con_0000000000000001

ID of this rule.

​
enabled
boolean
default:true

Whether the rule is enabled (true), or disabled (false).

​
script
string
default:function (user, context, callback) { callback(null, user, context); }

Code to be executed when this rule runs.

​
order
number
default:1

Order that this rule should execute in relative to other rules. Lower-valued rules execute first.

​
stage
string
default:login_success

Execution stage of this rule. Can be login_success, login_failure, or pre_authorize.