メインコンテンツへスキップ
GET
/
rules
/
{id}
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.rules.get("id", {
        fields: "fields",
        includeFields: true,
    });
}
main();
{
  "name": "rule_1",
  "id": "con_0000000000000001",
  "enabled": true,
  "script": "function (user, context, callback) {\n  callback(null, user, context);\n}",
  "order": 1,
  "stage": "login_success"
}

承認

Authorization
string
header
必須

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

パスパラメータ

id
string
必須

ID of the rule to retrieve.

Pattern: ^rul_[A-Za-z0-9]{16}$

クエリパラメータ

fields
string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

Pattern: ^((name)|(enabled)|(script)|(order)|(id)|(stage))(,((name)|(enabled)|(script)|(order)|(id)|(stage)))*$
include_fields
boolean

Whether specified fields are to be included (true) or excluded (false).

レスポンス

Rule successfully retrieved.

name
string
デフォルト:rule_1

Name of this rule.

id
string
デフォルト:con_0000000000000001

ID of this rule.

enabled
boolean
デフォルト:true

Whether the rule is enabled (true), or disabled (false).

script
string
デフォルト:function (user, context, callback) { callback(null, user, context); }

Code to be executed when this rule runs.

order
number
デフォルト:1

Order that this rule should execute in relative to other rules. Lower-valued rules execute first.

stage
string
デフォルト:login_success

Execution stage of this rule. Can be login_success, login_failure, or pre_authorize.