Obtenir une Rule par id

Récupère les détails de la Rule. Accepte une liste de champs à inclure ou à exclure du résultat.

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

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.GetRuleRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Rules.Get(
        context.TODO(),
        "id",
        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 chemin

id · string · requis

ID de la Rule à récupérer.

Paramètres de requête

fields · string

Liste de champs séparés par des virgules à inclure ou à exclure du résultat (selon la valeur fournie pour include_fields). Laissez 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

Rule récupérée avec succès.

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 dans lequel cette Rule doit s’exécuter par rapport aux autres Rules. Les Rules ayant la valeur la plus faible s’exécutent en premier.

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

Code exécuté 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.