ルールを取得 - Auth0 Docs

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
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    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,
        ),
    }
    mgmt.Rules.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListRulesRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.rules().list(
            ListRulesRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .enabled(true)
                .fields("fields")
                .includeFields(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Rules\Requests\ListRulesRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->rules->list(
    new ListRulesRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'enabled' => true,
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.rules.list(
    page=1,
    per_page=1,
    include_totals=True,
    enabled=True,
    fields="fields",
    include_fields=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.rules.list(
  page: 1,
  per_page: 1,
  include_totals: true,
  enabled: true,
  fields: "fields",
  include_fields: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.rules.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        enabled: true,
        fields: "fields",
        includeFields: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.rules.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        enabled: true,
        fields: "fields",
        includeFields: true,
    });
}
main();

[
  {
    "enabled": true,
    "id": "con_0000000000000001",
    "name": "rule_1",
    "order": 1,
    "script": "function (user, context, callback) {\n  callback(null, user, context);\n}",
    "stage": "login_success"
  }
]

GET

https://{tenantDomain}/api/v2

rules

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
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    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,
        ),
    }
    mgmt.Rules.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListRulesRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.rules().list(
            ListRulesRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .enabled(true)
                .fields("fields")
                .includeFields(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Rules\Requests\ListRulesRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->rules->list(
    new ListRulesRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'enabled' => true,
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.rules.list(
    page=1,
    per_page=1,
    include_totals=True,
    enabled=True,
    fields="fields",
    include_fields=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.rules.list(
  page: 1,
  per_page: 1,
  include_totals: true,
  enabled: true,
  fields: "fields",
  include_fields: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.rules.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        enabled: true,
        fields: "fields",
        includeFields: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.rules.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        enabled: true,
        fields: "fields",
        includeFields: true,
    });
}
main();

[
  {
    "enabled": true,
    "id": "con_0000000000000001",
    "name": "rule_1",
    "order": 1,
    "script": "function (user, context, callback) {\n  callback(null, user, context);\n}",
    "stage": "login_success"
  }
]

承認

Authorization

string

header

必須

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

クエリパラメータ

page

integer

返される結果のページ index。最初のページは 0 です。

必須範囲: x >= 0

per_page

integer

1 ページあたりの結果数。

必須範囲: 0 <= x <= 100

include_totals

boolean

結果を、総件数を含むオブジェクトとして返すか（true）、結果の配列を直接返すか（false、既定値）を指定します。

enabled

boolean

ルールが有効（true）か無効（false）かで絞り込むための任意のフィルターです。

fields

string

結果に含める、または結果から除外するフィールドのカンマ区切りリストです（include_fields に指定した値に基づきます）。すべてのフィールドを取得するには空のままにしてください。

include_fields

boolean

指定したフィールドを含めるか（true）、除外するか（false）を指定します。

レスポンス

ルールの取得に成功しました。

object[]
object

enabled

boolean

デフォルト:true

このルールが有効（true）か無効（false）か。

string

デフォルト:con_0000000000000001

このルールのID。

name

string

デフォルト:rule_1

このルールの名前。

order

number

デフォルト:1

他のルールに対するこのルールの実行順序。値が小さいルールほど先に実行されます。

script

string

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

このルールの実行時に実行されるコード。

stage

string

デフォルト:login_success

このルールの実行ステージ。login_success、login_failure、または pre_authorize を指定できます。