Configure Rules

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

To configure a Tenant ACL rule, you need a Management API access token with the following scopes:

• create:network_acls
• update:network_acls
• read:network_acls
• delete:network_acls

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

Available actions

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

Action	Endpoint	Required 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.

description · string · required

Describes the purpose or functionality of the rule.

Example: Only allow requests originating from the United States

active · boolean · required

Enables or disables the rule.

Example: true

priority · number · required

Numerical value that determines the order in which the rule is evaluated.

Example: 1

rule · object · required

Contains the conditions and actions of the rule.

Show child attributes

action · object · required

Contains the action that the rule performs.

Example: { allow: true }

match · object

Defines the condition(s) that the incoming request must fulfill.

Example: { geo_country_codes: ["US"] }

not_match · object

Defines the condition(s) that the incoming request must not fulfill.

Example: { geo_country_codes: ["CN"] }

scope · string · required

Service or context in which the rule is enforced.

Example: authentication

Examples

Toggle monitoring mode for a rule

You can enable monitoring mode for a Tenant ACL rule with the Management API Update access control list endpoint.

Add the log property to the rule.action object and set its value to true.