AvantGuard - Phin Security icon

AvantGuard - Phin Security

AvantGuard - Phin Security

Actions6

Overview

This node integrates with the AvantGuard Phin Security API to retrieve usage information for a specific partner. It is useful in scenarios where you need to monitor or analyze the activity or consumption metrics associated with a partner account within the AvantGuard system. For example, a security operations team might use this node to fetch usage data to track how much a partner has utilized certain services or features over time.

Properties

Name Meaning
Partner Id The unique identifier of the partner whose usage data you want to retrieve.

Output

The node outputs JSON data containing the usage details of the specified partner. This typically includes metrics and statistics related to the partner's activity as provided by the AvantGuard Phin Security API. The exact structure depends on the API response but generally includes fields such as usage counts, timestamps, and possibly limits or quotas.

If the node supports binary data output (not indicated here), it would represent any files or attachments returned by the API, but based on the code and context, the output is JSON only.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard Phin Security API.
  • Depends on the external service at https://api.phinsec.io.
  • Uses the @avantguardllc/n8n-openapi-node package to build properties from the OpenAPI specification.
  • The node expects the OpenAPI definition file (openapi.json) bundled alongside the code.

Troubleshooting

  • Missing or invalid Partner Id: Ensure that the "Partner Id" property is correctly set and corresponds to a valid partner in the AvantGuard system.
  • Authentication errors: Verify that the API key credential is properly configured and has sufficient permissions.
  • Network or API errors: Check connectivity to https://api.phinsec.io and confirm the API service is operational.
  • Unexpected API responses: If the output JSON structure changes, verify compatibility with the current API version and update the node if necessary.

Links and References

Discussion