Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node interacts with the "Connect Secure" API to retrieve custom profile data from an external scanning service. Specifically, the "Retrieve Custom Profile" operation fetches user profile information based on various query parameters such as user ID, filtering conditions, pagination controls, and sorting preferences.

Typical use cases include:

  • Fetching detailed user profiles for security or compliance audits.
  • Integrating user profile data into workflows that require enriched user context.
  • Querying large datasets with filtering, skipping, limiting, and ordering capabilities to manage data volume efficiently.

For example, a security analyst might use this node to retrieve profiles of users who meet certain risk criteria, skip already processed records, limit the number of results per request, and order them by last login time.

Properties

Name Meaning
X USER ID The User ID header value used to identify the user whose custom profile is being retrieved. This is required.
Condition A query string to filter the profiles based on specific conditions (e.g., status, attributes).
Skip Number of records to skip in the result set, useful for pagination.
Limit Maximum number of records to return, controlling the size of the response.
Order By Field name(s) to order the results by, allowing sorted output (e.g., "createdAt DESC").

Output

The node outputs JSON data representing the retrieved custom profiles matching the specified query parameters. Each item in the output corresponds to a user profile object returned by the external scan service.

If the API supports binary data (not indicated here), it would typically represent attachments or files related to the profiles, but this node focuses on JSON profile data only.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • Depends on the external Connect Secure service being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Missing or invalid X USER ID: Since the user ID header is required, omitting it or providing an incorrect value will likely cause authentication or authorization errors. Ensure the correct user ID is provided.
  • Invalid query parameters: Incorrectly formatted condition, skip, limit, or order_by values may lead to API errors or empty responses. Validate these inputs before execution.
  • API connectivity issues: Network problems or misconfigured credentials can cause failures. Verify API endpoint accessibility and credential validity.
  • Pagination mishandling: Using skip and limit incorrectly might result in missing or duplicated data across multiple requests. Use consistent pagination logic.

Links and References


Note: The summary is based solely on static analysis of the provided source code and property definitions.

Discussion