AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

This node operation performs bulk deletion of agent local users by their IDs. It is useful in scenarios where you need to remove multiple user records from a system efficiently, such as cleaning up inactive or obsolete user accounts in bulk. For example, an administrator might use this node to delete all users who have left an organization or to remove test accounts created during development.

Properties

Name Meaning
Additional Query Parameters Optional query parameters to refine the request. Currently supports:
- Name Search: A search term to filter clients by their friendly name (friendly_name).
Ids Required. A JSON array of user IDs that will be deleted in bulk.
Additional Body Fields Optional additional fields to include in the request body. Currently supports:
- Exclude Ids: A JSON array of user IDs to exclude from deletion, even if they appear in the Ids list.

Output

The node outputs JSON data representing the result of the bulk delete operation. This typically includes confirmation of which user IDs were successfully deleted and any errors encountered for specific IDs. The output does not handle binary data.

Dependencies

  • Requires an API key credential for authentication with the external service managing agent local users.
  • The node sends HTTP requests to the configured API endpoint (base URL not explicitly shown here).
  • No other external dependencies are indicated.

Troubleshooting

  • Invalid JSON in Ids or Exclude Ids: Since these properties expect JSON arrays, providing malformed JSON will cause errors. Ensure valid JSON syntax.
  • Empty or Missing Ids: The Ids property is required. Omitting it or providing an empty array may result in no action or an error.
  • API Authentication Errors: If the API key credential is missing or invalid, the node will fail to authenticate.
  • Excluding Non-existent IDs: Specifying IDs in Exclude Ids that do not exist in the Ids list has no effect but should not cause errors.
  • Name Search Parameter Misuse: Using the Name Search query parameter filters clients by name but does not affect which IDs are deleted; misuse may lead to unexpected results.

Links and References

  • No direct links provided in the source code.
  • Refer to the API documentation of the service managing agent local users for details on bulk delete endpoints and parameters.

Discussion