Obtener las Rules

Recupere una lista filtrada de Rules. Acepta una lista de campos para incluirlos o excluirlos.

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"
  }
]

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de consulta

page · integer

Índice de página de los resultados que se devolverán. La primera página es 0.

Rango requerido: x >= 0

per_page · integer

Número de resultados por página.

Rango requerido: 0 <= x <= 100

include_totals · boolean

Devuelva los resultados dentro de un objeto que contenga el recuento total de resultados (true) o como un array directo de resultados (false, valor predeterminado).

enabled · boolean

Filtro opcional sobre si una Rule está habilitada (true) o deshabilitada (false).

fields · string

Lista de campos separados por comas para incluir o excluir (según el valor proporcionado para include_fields) en el resultado. Déjelo vacío para recuperar todos los campos.

include_fields · boolean

Indica si los campos especificados deben incluirse (true) o excluirse (false).

Respuesta

200

application/json

Rules recuperadas correctamente.

object[]

object

enabled · boolean · predeterminado: true

Indica si la Rule está habilitada (true) o deshabilitada (false).

id · string · predeterminado: con_0000000000000001

ID de esta Rule.

name · string · predeterminado: rule_1

Nombre de esta Rule.

order · number · predeterminado: 1

Orden relativo en el que debe ejecutarse esta Rule con respecto a otras Rules. Las Rules con valores más bajos se ejecutan primero.

script · string · predeterminado: function (user, context, callback) { callback(null, user, context); }

Code que se ejecutará cuando se ejecute esta Rule.

stage · string · predeterminado: login_success

Etapa de ejecución de esta Rule. Puede ser login_success, login_failure o pre_authorize.