Obtener una Rule por id

Recupera los detalles de una Rule. Acepta una lista de campos para incluirlos o excluirlos del resultado.

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

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de ruta

id · string · requerido

ID de la Rule que se va a recuperar.

Parámetros de consulta

fields · string

Lista de campos separados por comas para incluir o excluir del resultado (según el valor proporcionado para include_fields). 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

Rule recuperada correctamente.

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 de ejecución de esta Rule en relación con otras Rules. Las Rules con valores más bajos se ejecutan primero.

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

Código 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.