AvantGuard - CIPP icon

AvantGuard - CIPP

AvantGuard - CIPP

Actions136

Overview

This node operation, "Retrieve Exec Assign Policy" under the "List" resource, is designed to query and retrieve executive assignment policies based on specific filtering criteria. It is useful in scenarios where you need to fetch policy details related to assignments for executives or users within a tenant or organizational context. For example, it can be used to programmatically obtain assignment policies filtered by assignee, display name, type, and tenant filter parameters, which helps automate governance or compliance workflows.

Properties

Name Meaning
Assignto The identifier or name of the entity (e.g., user or role) to whom the policy is assigned.
Displayname The display name associated with the policy or assignment, used for identification.
Id The unique identifier of the policy to retrieve.
Tenantfilter A filter string specifying the tenant or organizational scope to limit the query.
Type The type/category of the assignment policy to retrieve.

Output

The node outputs JSON data representing the retrieved executive assignment policy or policies matching the provided filters. The structure of the JSON output corresponds to the API response from the external service and typically includes fields such as policy details, assignment information, identifiers, and metadata relevant to the queried policy.

No binary data output is indicated or expected from this operation.

Dependencies

  • Requires an API key credential for authentication to the AvantGuard CIPP API.
  • Depends on the external AvantGuard CIPP API endpoint configured via the node's credentials (resourceApiUrl).
  • Uses HTTP headers to accept and send JSON content.
  • The node relies on the @avantguardllc/n8n-openapi-node package and an OpenAPI specification (openapi.json) bundled with the node for request building.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key credential is correctly configured and has access to the specified API URL.
  • Invalid or missing required properties: All input properties (assignto, displayname, id, tenantfilter, type) are required; missing any will likely cause the request to fail.
  • API errors due to incorrect filters: If no results are returned or errors occur, verify that the filter values correspond to existing entities and valid types in the target system.
  • Network or connectivity issues: Confirm that the node can reach the configured API endpoint and that there are no firewall or proxy restrictions.

Links and References

Discussion