Update a rule

Update an existing rule.

PATCH https://{tenantDomain}/api/v2/rules/{id}

C#

C#

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Rules.UpdateAsync(
            id: "id",
            request: new UpdateRuleRequestContent()
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.UpdateRuleRequestContent{}
    mgmt.Rules.Update(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.UpdateRuleRequestContent;

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

        client.rules().update(
            "id",
            UpdateRuleRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Rules\Requests\UpdateRuleRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->rules->update(
    'id',
    new UpdateRuleRequestContent([]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.rules.update(
    id="id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.rules.update(id: "id")

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.rules.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.rules.update("id", {});
}
main();

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

200

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

Path Parameters

id · string · required

ID of the rule to retrieve.

Body

application/jsonapplication/x-www-form-urlencoded

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

Code to be executed when this rule runs.

Minimum string length: 1

name · string · default: my-rule

Name of this rule.

Pattern: ^[a-zA-Z0-9]([ \-a-zA-Z0-9]*[a-zA-Z0-9])?$

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

200

application/json

Rule successfully updated.

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.