ルールを作成

新しいルール を作成します。

注: ルールの実行ステージを既定の login_success から変更すると、ルールの関数シグネチャが変わり、user が省略されることがあります。

POST https://{tenantDomain}/api/v2/rules

C#

C#

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.CreateAsync(
            new CreateRuleRequestContent {
                Name = "name",
                Script = "script"
            }
        );
    }

}

201

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

name · string · デフォルト: my-rule · 必須

このルールの名前。

Pattern: ^[a-zA-Z0-9]([ \-a-zA-Z0-9]*[a-zA-Z0-9])?$

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

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

Minimum string length: 1

enabled · boolean · デフォルト: true

このルールが有効（true）か無効（false）かを示します。

order · number · デフォルト: 2

このルールを他のルールとの相対的な順序でどの位置に実行するかを示します。値が小さいルールほど先に実行されます。

必須範囲: x >= 0

レスポンス

201

application/json

ルールの作成に成功しました。

enabled · boolean · デフォルト: true

このルールが有効（true）か無効（false）かを示します。

id · 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 を指定できます。