Récupérer les Rules

Récupérer une liste filtrée de Rules. Accepte une liste de champs à inclure ou à exclure.

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

[
  {
    "enabled": true,
    "id": "con_0000000000000001",
    "name": "rule_1",
    "order": 1,
    "script": "function (user, context, callback) {\n  callback(null, user, context);\n}",
    "stage": "login_success"
  }
]

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de requête

page · integer

Indice de la page de résultats à renvoyer. La première page est 0.

Plage requise: x >= 0

per_page · integer

Nombre de résultats par page.

Plage requise: 0 <= x <= 100

include_totals · boolean

Retourne les résultats dans un objet contenant le nombre total de résultats (true) ou sous la forme d’un tableau direct de résultats (false, par défaut).

enabled · boolean

Filtre facultatif indiquant si une Rule est activée (true) ou désactivée (false).

fields · string

Liste de champs séparés par des virgules à inclure ou à exclure (selon la valeur fournie pour include_fields) dans le résultat. Laissez ce champ vide pour récupérer tous les champs.

include_fields · boolean

Indique si les champs spécifiés doivent être inclus (true) ou exclus (false).

Réponse

200

application/json

Rules récupérées avec succès.

object[]

object

enabled · boolean · défaut: true

Indique si la Rule est activée (true) ou désactivée (false).

id · string · défaut: con_0000000000000001

ID de cette Rule.

name · string · défaut: rule_1

Nom de cette Rule.

order · number · défaut: 1

Ordre d’exécution de cette Rule par rapport aux autres Rules. Les Rules ayant une valeur inférieure s’exécutent d’abord.

script · string · défaut: function (user, context, callback) { callback(null, user, context); }

Code à exécuter lorsque cette Rule s’exécute.

stage · string · défaut: login_success

Étape d’exécution de cette Rule. Peut être login_success, login_failure ou pre_authorize.