AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure
Join our community

Actions223

Overview

This node is designed to update PII (Personally Identifiable Information) scan settings via a PATCH operation. It allows users to modify scan configurations such as scan settings, path settings, allowed file extensions, and agent IDs associated with the scanning process. This node is useful in scenarios where an organization needs to dynamically adjust how their PII scanning operates, for example, updating which directories to scan or changing the types of files to include/exclude without redeploying or manually editing configuration files.

Practical examples:

  • Updating the list of file extensions that should be scanned for PII.
  • Changing the scan paths to include new directories.
  • Modifying agent IDs responsible for performing scans.
  • Adjusting scan settings parameters to refine detection sensitivity or scope.

Properties

Name Meaning
X USER ID User identifier required for authentication or tracking purposes in the request header.
Additional Body Fields Optional fields to include in the request body:
- Data JSON object containing scan settings, path settings, allowed extension types, and agent IDs.
- Id Numeric identifier representing the specific PII scan setting record to update.

The "Data" field expects a JSON string that will be parsed and sent as part of the request body. It typically includes arrays for scan_settings, path_settings, allowed_extension_types, and agent_ids.

Output

The node outputs JSON data representing the response from the API after attempting to patch the PII scan settings. The structure of this JSON depends on the API's response but generally includes confirmation of updated fields or error messages if the update failed.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating requests to the AvantGuard ConnectSecure service.
  • The base URL for the API must be configured in the node credentials.
  • Uses the @avantguardllc/n8n-openapi-node package and an OpenAPI specification (openapi.json) bundled within the node for request building and validation.

Troubleshooting

  • Missing or invalid X USER ID: Since the user ID header is required, omitting it or providing an incorrect value may result in authentication errors or request rejection.
  • Malformed JSON in Data field: The "Data" property expects a valid JSON string. Invalid JSON will cause parsing errors before sending the request.
  • Invalid Id value: The "Id" field must be a valid number corresponding to an existing scan setting; otherwise, the API may return a not found or validation error.
  • API connectivity issues: Ensure the base URL and API credentials are correctly set up in n8n to avoid connection failures.
  • Permission errors: The authenticated user must have sufficient permissions to update PII scan settings.

Links and References

Discussion