AvantGuard - CIPP icon

AvantGuard - CIPP

AvantGuard - CIPP

Actions136

Overview

This node interacts with the AvantGuard CIPP API to retrieve tenant lists based on specified filters and options. It is useful in scenarios where users need to programmatically access tenant information from the AvantGuard system, such as for reporting, synchronization, or management tasks.

For example, a user might want to fetch all tenants that match certain criteria or clear cached tenant data before retrieving fresh information.

Properties

Name Meaning
Alltenantselector A string value used as a query parameter to select all tenants according to a specific filter or selector logic.
Clearcache A string flag indicating whether to clear the cache before retrieving tenant data.
Tenantfilter A string used to filter tenants based on certain criteria.
Tenantsonly A string flag specifying whether to retrieve only tenant-related data.

Output

The node outputs JSON data containing the list of tenants retrieved from the AvantGuard CIPP API. The structure of the JSON output corresponds to the API response, typically including tenant details filtered and selected according to the input properties.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard CIPP API.
  • The base URL for the API is configured via credentials.
  • Uses the @avantguardllc/n8n-openapi-node package and an OpenAPI specification (openapi.json) bundled with the node for request building.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid values for query parameters (e.g., alltenantselector, clearcache) may result in empty responses or 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 allowed values of input properties.
    • Timeout or network errors require checking internet connection and API endpoint availability.

Links and References

Discussion