ACL debugging tools
Summarize
Summary of ACL debugging tools
ServiceNow provides ACL debugging tools to help customers troubleshoot and debug Access Control Lists (ACLs) effectively. These tools offer detailed insights into field-level security, ACL evaluation results, and related ACL configurations when modifying rules. This enables administrators and security personnel to understand why access might be allowed or denied in various scenarios.
Show less
Field level debugging
When ACL debugging is enabled via System Security > Debugging > Debug Security Rules, a bug icon appears next to fields with ACL rules. Clicking this icon reveals which ACL rules apply and their evaluation results for that field. Administrators can impersonate other users to observe ACL passes and failures as that user would experience them, helping to replicate and diagnose access issues. Note that impersonation respects ACL restrictions, so users can only see what the impersonated user would see.
To facilitate easier debugging, read-only access to key ACL-related tables is enabled by default during impersonation, controlled by the system property glide.security.accessaclasimpersonator. If set to false, an admin session may be needed to debug ACLs because impersonated users might lack access to ACL data.
ACL rule output messages
ACL debugging also displays detailed output messages at the bottom of lists and forms, showing:
- TIME: Total processing time for the ACL rule.
- PATH: Unique identifier of the ACL rule (type/name/operation).
- CONTEXT: The object being evaluated.
- RC (Return Code): True if ACL passed, false if failed.
- RULE: Summary of rule processors and detailed results for each ACL evaluation category, including system checks (iAccessHandler), role verification, condition checks, and scripts.
Icons visually indicate ACL evaluation results:
- Green checkmark (✔️): Passed criteria
- Red X (❌): Failed criteria
- Gray circle (⚪): Evaluation not needed
- Blue icons: Cached results of previous ACL checks, with the same meanings as above
Practical usage
Administrators can filter the debug output to show or hide security rules and other messages. Clicking an ACL name in the output opens the ACL record directly for editing. Hovering over icons reveals more details about each ACL check, aiding in precise troubleshooting.
These debugging tools provide a clear, actionable way to analyze and resolve ACL-related access issues, ensuring that ServiceNow customers can maintain secure and correctly configured access controls across their instances.
Field level debugging and access ACL rule output messages are available to help you troubleshoot and debug ACLs. The ACL configuration watcher lets you know what related ACLs exist when you modify one.
Field level debugging
When debugging is enabled, a small bug icon () appears beside each field with an ACL rule. Clicking the icon lists the ACL rules
that apply for the field and the evaluation results. Enable debugging by navigating to .
After enabling ACL debugging, you can impersonate another user to see what ACL rules the user passes and fails. When you impersonate a user, you can only see what that user is allowed to see. For example, you cannot view a record that an ACL prevents the user from seeing. To make debugging easier, read-only access to certain ACL-related tables is enabled by default, even when impersonating a user that does not have read access to the tables. To change this functionality, set the following property to false.
To enable ACL rule debugging, navigate to .
| System property | Description | Default setting |
|---|---|---|
| glide.security.access_acl_as_impersonator | Allows read access to the following tables while impersonating a user: sys_security_acl, sys_security_operation, sys_security_type, and sys_user_role. As a result, the impersonating user can read data that the impersonated user cannot read. | true Note: When the property is set to false, the impersonated user might be
prevented from reading ACL-related data. In this case, a second session logged
in as admin or security_admin might be required to debug ACLs. |
ACL rule output messages
ACL debugging displays ACL rule output messages at the bottom of each list and form. The output message displays the following:
| Message element | Description |
|---|---|
| TIME | The total time used to process this ACL rule. |
| PATH | Information that uniquely identifies each ACL rule in the format: <ACL rule type>/<ACL rule name>/<Operation>. |
| CONTEXT | The object being evaluated by the ACL rule. |
| RC | The return code of the ACL rule. A true value passes the ACL rule. A false value fails the ACL rule. |
| RULE | A brief summary of processors and scripts, followed by ACL results for each
table-level and field-level ACL evaluation. Most ACL evaluations show an overall
pass or fail result followed by a breakdown of the results for each type of ACL
criteria:
|
The icons that appear show how the ACL was evaluated:
| Icon | Description |
|---|---|
| A green checkmark ( |
Indicates the table or field passed the criteria. |
| A red x icon ( |
Indicates the table or field did not pass. |
| An empty gray circle icon ( |
Indicates the ACL evaluation did not need to be performed. |
| A blue checkmark, x, or empty circle | Indicates that the ACL was taken from a cached result of a previous ACL check. The icons mean the same as the above. |
- Select or clear these check boxes at the top of the debug output:
- Security rules: Show or hide the results of the ACL checks.
- Others: Show or hide other warnings or messages.
- Click the name of the ACL next to any of the output messages to open that ACL record.
- Hover the cursor over any of the icons for the four ACL checks to see more information.