Get rules

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

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

Go

Go

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,
    )
}

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.