Get rules

Retrieve a filtered list of rules. Accepts a list of fields to include or exclude.

GET 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.ListAsync(
            new ListRulesRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Enabled = true,
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

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.ListRulesRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Enabled: management.Bool(
            true,
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Rules.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

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

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

        client.rules().list(
            ListRulesRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .enabled(true)
                .fields("fields")
                .includeFields(true)
                .build()
        );
    }
}

<?php

namespace Example;

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

$client = new Management(
    token: '<token>',
);
$client->rules->list(
    new ListRulesRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'enabled' => true,
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

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

client.rules.list(
    page=1,
    per_page=1,
    include_totals=True,
    enabled=True,
    fields="fields",
    include_fields=True,
)

require "auth0"

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

client.rules.list(
  page: 1,
  per_page: 1,
  include_totals: true,
  enabled: true,
  fields: "fields",
  include_fields: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.rules.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        enabled: true,
        fields: "fields",
        includeFields: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.rules.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        enabled: true,
        fields: "fields",
        includeFields: true,
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/rules \
  --header 'Authorization: Bearer <token>'

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.

Query Parameters

page · integer

Page index of the results to return. First page is 0.

Required range: x >= 0

per_page · integer

Number of results per page.

Required range: 0 <= x <= 100

include_totals · boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

enabled · boolean

Optional filter on whether a rule is enabled (true) or disabled (false).

fields · string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

include_fields · boolean

Whether specified fields are to be included (true) or excluded (false).

Response

200

application/json

Rules successfully retrieved.

object[]

object

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.