テナントアクセス制御リストのルールで監視モードを有効または無効にする方法

監視モードを有効にすると、テナントアクセス制御リストの現在の動作を変更せずに、ルールが受信トラフィックにどのような影響を与えるかを監査できます。

ルールが監視モードの場合、Tenant ACL はそのルールを評価し、テナントログイベントを生成しますが、ルールのアクションは実行せず、後続のルールやリストの評価も中断しません。

監視モードを有効にするには、ルールの action プロパティ log を true に設定します。

Management API

以下の本文を指定して、Management API のアクセス制御リストを部分的に更新するエンドポイントを呼び出します。

Management API request body

{
  "rule": {
    "action": {
      "log": true
    },
    "scope": "authentication"
  }
}

Go SDK

package main

import (
	"context"
	"log"

	"github.com/auth0/go-auth0"
	"github.com/auth0/go-auth0/management"
)

func main() {
	mgmt, err := management.New("{yourDomain}", management.WithClientCredentials("{yourClientId}", "{yourClientSecret}"))
	if err != nil {
		log.Fatal(err)
	}

	networkACL := &management.NetworkACL{
		Rule: &management.NetworkACLRule{
			Action: &management.NetworkACLRuleAction{
				Log: auth0.Bool(true),
			},
			Scope: auth0.String("authentication"),
		},
	}

	err = mgmt.NetworkACL.Patch(context.Background(), "{yourTenantAclRuleId}", networkACL)
	if err != nil {
		log.Fatal(err)
	}
	log.Println("Network ACL has been updated to enable monitoring mode")

Node SDK

const updateNetworkAclPayload: Management.UpdateNetworkAclRequestContent = {
  rule: {
    action: {
      log: true,
    },
    scope: "authentication"
  }
};

const updateNetworkAcl = await client.networkAcls.update("{yourTenantAclRuleId}", updateNetworkAclPayload);

Terraform

リソースブロックの rule.action で、log を true に設定します。

resource "auth0_network_acl" "example_acl" {
    description = "Example ACL"
    active = true
    priority = 1
    rule {
        action {
            block = true
            log = true
        }
        scope = "authentication"
        match {
          hostnames = ["example.com"]
        }
    }
}

Deploy CLI

exampleACLs:
  - description: Example ACL
    active: true
    priority: 1
    rule:
      action:
        block: true
        log: true
      match:
        hostnames:
          - "example.com"
      scope: authentication

Auth0 CLI

auth0 network-acl update {yourTenantAclRuleId} --action log

同様に、log プロパティを false に設定すると、監視モードを無効にできます。