AvantGuard - CIPP icon

AvantGuard - CIPP

AvantGuard - CIPP

Actions136

Overview

This node interacts with the AvantGuard CIPP API to retrieve specific lists based on given parameters. In particular, the "Retrieve List Bpa" operation under the "List" resource fetches a list filtered by report type and tenant filter criteria. This is useful in scenarios where users need to dynamically query and obtain filtered data sets from the AvantGuard system, such as generating reports or filtering tenant-specific information.

Practical examples include:

  • Fetching a report list for a specific report type.
  • Filtering data according to tenant-specific filters to customize outputs per client or user group.

Properties

Name Meaning
Report The report identifier or name used to specify which report list to retrieve.
Tenantfilter A filter string that limits the list results to a specific tenant or group of tenants.

Output

The node outputs JSON data representing the retrieved list from the AvantGuard CIPP API. The structure of the json output field corresponds directly to the API response for the requested report and tenant filter. It typically contains an array or object with the relevant list entries matching the query parameters.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard CIPP API.
  • Needs the base URL of the AvantGuard resource API configured in credentials.
  • Depends on the external @avantguardllc/n8n-openapi-node package for building request properties and handling API communication.
  • The node sends HTTP requests with headers specifying JSON content type and expects JSON responses.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid or empty values for "Report" or "Tenantfilter" may result in empty responses or API errors.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • Authentication errors typically indicate invalid or missing API keys; verify credentials configuration.
    • API response errors related to query parameters suggest checking the correctness and existence of the specified report and tenant filter.
    • Timeout or connection errors require checking network access and API endpoint availability.

Links and References

Discussion