Configure Rules

Learn how to configure Tenant Access Control List (ACL) rules with the Auth0 Management API.

You can configure Tenant Access Control List (ACL) rules with the Auth0 Management API.

​

Available actions

You can view, create, update, overwrite, and delete Tenant ACL rules with the Management API.

Action	Endpoint	Require scope
View a rule	Get a specific access control list entry for a tenant	read:network_acls
View all rules	Get all access control list entries for a tenant	read:network_acls
Create a rule	Create access control list	create:network_acls
Update a rule	Partial update for an access control list	update:network_acls
Overwrite a rule	Update access control list	update:network_acls
Delete a rule	Delete access control list	delete:network_acls

​

Parameters

For detailed information about Tenant ACL parameters and how to use them, read Reference.

Parameter	Data type	Description
description	string	Describes the purpose or functionality of the rule.
active	boolean	Enables or disables the rule.
priority	number	Numerical value that determines the order in which the rule is evaluated. Lower values indicate higher priority.
rule	object	Contains the following properties: action: object. Contains the action the rule performs. match: object. Defines the conditions that the incoming request must fulfill. not_match: object. Defines the conditions that the incoming request must not fulfill. scope: string. Service or context in which the rule is enforced.

​

Example: Block all traffic from a given country

Here’s an example of a Tenant ACL rule that blocks all incoming traffic from China.

Management API

To create a Tenant ACL rule with the Management API:

1. Get a Management API access token with the create:network_acls scope.

2. Call the Management API Create access control list endpoint with the following body:

   {
     "description": "Block all traffic from China",
     "active": true,
     "priority": 1,
     "rule": {
       "action": {
         "block": true
       },
       "match": {
         "geo_country_codes": ["CN"]
       },
       "scope": "authentication"
     }
   }
   

​

Toggle monitoring mode for a rule

You can enable or disable monitoring mode for a Tenant ACL rule by setting the rule.action.log object to true or false, respectively.

​

Example: Enable monitoring mode for an existing Tenant ACL rule

Management API

To enable monitoring mode for a Tenant ACL rule with the Management API:

1. Get a Management API access token with the update:network_acls scope.

2. Call the Management API Partial update for an access control list endpoint with the following body:

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