AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure

Actions223

Overview

This node operation, Get Retrieve Compliance Assessment, is designed to fetch compliance assessment data from an external service. It allows users to retrieve detailed information about compliance assessments by specifying user identification and optional query parameters to filter, sort, or limit the results.

Typical use cases include:

  • Retrieving compliance reports for a specific user.
  • Filtering compliance assessments based on conditions such as status or date.
  • Paginating through large sets of compliance data by skipping records or limiting the number returned.
  • Ordering the retrieved compliance assessments by specified fields.

For example, a security analyst might use this node to pull all compliance assessments related to a particular user ID, filtered to show only those assessments that failed certain criteria, ordered by the most recent date.

Properties

Name Meaning
X USER ID The User Id required to identify which user's compliance assessments to retrieve.
Additional Query Parameters Optional parameters to refine the query:
- Condition: A query condition string to filter results.
- Skip: Number of records to skip (for pagination).
- Limit: Maximum number of records to return.
- Order By: Field(s) to order the results by.

Output

The output of this node operation is JSON data representing the retrieved compliance assessments. Each item in the output corresponds to a compliance assessment record fetched from the external service.

The structure typically includes fields relevant to compliance assessments such as assessment details, status, timestamps, and any metadata provided by the API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authentication with the external compliance assessment service.
  • The base URL for the API must be configured in the node credentials.
  • The node sends HTTP requests with headers including Accept: application/json and Content-Type: application/json.
  • The X-USER-ID header must be set with the user ID value for the request.

Troubleshooting

  • Missing or invalid X USER ID: The node requires a valid user ID; ensure this property is set correctly. Errors may occur if it is missing or malformed.
  • API authentication errors: If the API key or base URL is incorrect or expired, the node will fail to authenticate. Verify credentials are correct and active.
  • Invalid query parameters: Providing unsupported or incorrectly formatted query parameters (e.g., non-numeric values for skip/limit) may cause the API to reject the request.
  • Empty or no results: If the condition filters are too restrictive or the user ID has no associated assessments, the output may be empty.
  • Network issues: Connectivity problems can cause timeouts or failures; check network access to the API endpoint.

Links and References

  • Refer to the external compliance assessment API documentation for detailed descriptions of query parameters and response schema.
  • n8n documentation on HTTP Request nodes and custom node development for understanding how headers and query parameters are routed.

Discussion