AvantGuard - CIPP icon

AvantGuard - CIPP

AvantGuard - CIPP

Actions136

Overview

This node integrates with the AvantGuard CIPP API to retrieve and edit transport rules within a specified list resource. Specifically, for the "List" resource and the "Retrieve Edit Transport Rule" operation, it fetches details about a particular transport rule identified by a GUID, along with state and tenant filter parameters.

Common scenarios where this node is beneficial include:

  • Managing email or data transport rules in an enterprise environment.
  • Automating retrieval and modification of transport rules based on dynamic inputs.
  • Integrating transport rule management into broader workflows such as compliance checks or automated updates.

For example, a user might use this node to programmatically retrieve the current configuration of a transport rule before applying changes or auditing its settings.

Properties

Name Meaning
Guid The unique identifier (GUID) of the transport rule to retrieve or edit.
State The state parameter related to the transport rule, possibly indicating status or mode.
Tenantfilter A filter string specifying the tenant context for the transport rule retrieval/editing.

Output

The node outputs JSON data representing the transport rule details retrieved from the AvantGuard CIPP API. This JSON typically includes all relevant properties of the transport rule such as identifiers, conditions, actions, and metadata.

If the node supports binary data output, it would represent attachments or files related to the transport rule, but based on the provided code and properties, the output is primarily JSON.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard CIPP API.
  • Needs the base URL of the AvantGuard CIPP API configured in the node credentials.
  • Depends on the @avantguardllc/n8n-openapi-node package for building request properties and handling OpenAPI specifications.
  • The node sends HTTP requests with headers accepting and sending JSON content.

Troubleshooting

  • Missing or invalid GUID: Since the GUID is required, ensure it is correctly provided; otherwise, the API call will fail.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Incorrect state or tenantfilter values: These must match expected formats or values defined by the API; invalid values may cause errors or empty responses.
  • Network issues: Ensure connectivity to the configured API base URL.
  • API response errors: Check the API documentation for error codes returned when retrieving or editing transport rules.

Links and References

Discussion