Obtenir les Rules

Récupère une liste filtrée de rules. Accepte une liste de champs à inclure ou à exclure.

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 ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Rules.ListAsync(
            new ListRulesRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Enabled = true,
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

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

Index 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 forme de array de résultats directement (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 vide pour récupérer tous les champs.

include_fields · boolean

Indique si les champs précisé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 règle est activée (true) ou désactivée (false).

id · string · défaut: con_0000000000000001

ID de cette règle.

name · string · défaut: rule_1

Nom de cette règle.

order · number · défaut: 1

Ordre d’exécution de cette règle par rapport aux autres règles. Les règles dont la valeur est inférieure s’exécutent en premier.

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

Code exécuté lorsque cette règle s’exécute.

stage · string · défaut: login_success

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