Create a rule

Create a new rule.

Note: Changing a rule’s stage of execution from the default login_success can change the rule’s function signature to have user omitted.

POST https://{tenantDomain}/api/v2/rules

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Rules.CreateAsync(
            new CreateRuleRequestContent {
                Name = "name",
                Script = "script"
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.CreateRuleRequestContent{
        Name: "name",
        Script: "script",
    }
    client.Rules.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.rules.requests.CreateRuleRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .token("<token>")
            .build();

        client.rules().create(
            CreateRuleRequestContent
                .builder()
                .name("name")
                .script("script")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Rules\Requests\CreateRuleRequestContent;

$client = new Management(
    token: '<token>',
);
$client->rules->create(
    new CreateRuleRequestContent([
        'name' => 'name',
        'script' => 'script',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.rules.create(
    name="name",
    script="script",
)

require "auth0"

client = Auth0::Management.new(token: "<token>")

client.rules.create(
  name: "name",
  script: "script"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.rules.create({
        name: "name",
        script: "script",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.rules.create({
        name: "name",
        script: "script",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-rule",
  "script": "function (user, context, callback) {\n  callback(null, user, context);\n}",
  "order": 2,
  "enabled": true
}
'

201

{
  "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

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Body

application/jsonapplication/x-www-form-urlencoded

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

201

application/json

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.