AvantGuard - CIPP icon

AvantGuard - CIPP

AvantGuard - CIPP

Actions136

Overview

This node operation, named "Retrieve Exec Groups Delete" under the "List" resource, is designed to interact with an API endpoint that likely manages execution groups within a system. The operation appears to retrieve or delete specific execution group entries based on provided query parameters such as display name, group type, ID, and tenant filter.

Typical use cases include:

  • Retrieving details of a particular execution group by specifying its unique identifiers.
  • Deleting an execution group by providing the necessary identifying information.
  • Filtering execution groups by tenant or other attributes for management or auditing purposes.

For example, a user might want to delete an execution group identified by a certain ID and filtered by tenant, or retrieve information about a group with a specific display name and group type.

Properties

Name Meaning
Displayname The display name of the execution group to retrieve or delete.
Grouptype The type/category of the execution group.
Id The unique identifier of the execution group.
Tenantfilter A filter parameter to specify the tenant context for the operation (e.g., multi-tenant).

All these properties are required and are sent as query parameters in the API request.

Output

The node outputs JSON data representing the response from the API call related to the execution group retrieval or deletion. The exact structure depends on the API's response but typically includes details about the execution group(s) affected or retrieved.

If the operation involves deletion, the output may contain confirmation of deletion or status messages.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key credential for authentication with the AvantGuard CIPP API.
  • The base URL for the API is configured via credentials (resourceApiUrl).
  • Uses the @avantguardllc/n8n-openapi-node package to build properties and handle requests.
  • The node expects the API to accept and return JSON-formatted data.

Troubleshooting

  • Missing Required Parameters: Since all input properties are required, omitting any will likely cause the API request to fail. Ensure all fields (Displayname, Grouptype, Id, Tenantfilter) are provided.
  • Authentication Errors: If the API key credential is missing or invalid, the node will not authenticate successfully. Verify the API key and credential configuration.
  • API Endpoint Issues: Network errors or incorrect base URL settings can cause failures. Confirm the resourceApiUrl credential is correctly set.
  • Unexpected API Responses: If the API changes or returns unexpected data, the node output may not be as expected. Check API documentation and update node configuration accordingly.

Links and References

Discussion