AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

This node operation retrieves a list of agent local users from the AvantGuard DNSFilter API. It allows filtering and sorting of users based on various optional query parameters. This is useful in scenarios where you need to programmatically access or audit user information related to agents managed by the DNSFilter service, such as fetching all users in a specific organization or filtering users by name.

Practical examples include:

  • Fetching all agent local users within a particular organization for reporting.
  • Filtering users who belong to a certain collection.
  • Sorting users alphabetically by their name.

Properties

Name Meaning
Additional Query Parameters Optional filters and options to refine the list of agent local users. Includes:
- In A Collection Boolean flag to filter users that are part of a collection (true/false).
- Name Filter users by name; if friendly_name is not found, it searches by user_name.
- Organization Ids JSON array of organization IDs to filter users by; defaults to the user's organization ID.
- Page JSON object specifying pagination details like page number and size.
- Sort String to specify sorting options; valid attribute is name.

Output

The node outputs JSON data containing the list of agent local users matching the specified query parameters. Each item in the output typically includes user details such as names, organization IDs, and collection membership status.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard DNSFilter API.
  • The node uses the base URL https://api.dnsfilter.com for API requests.
  • Proper configuration of the API authentication credential in n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrectly formatted JSON in the "Organization Ids" or "Page" fields may result in request errors.
    • Using unsupported sort attributes may lead to API errors or ignored parameters.
  • Error messages:

    • Authentication errors typically indicate invalid or expired API keys; verify and update credentials.
    • Validation errors on query parameters suggest malformed input; ensure JSON fields are correctly structured.
    • Network or timeout errors may require checking connectivity or API service status.

Links and References

Discussion