Actions6
- 🏭 Partner Actions
- 🏣 Company Actions
Overview
This node integrates with the AvantGuard Phin Security API to retrieve usage information for a specific company under a given partner. It is useful in scenarios where you need to monitor or analyze the security-related usage metrics of companies managed by partners, such as tracking API consumption, security event counts, or other usage statistics provided by the service.
For example, a security operations team could use this node to fetch real-time usage data for a company to ensure compliance with licensing limits or to audit activity levels.
Properties
Name | Meaning |
---|---|
Partner Id | The unique identifier of the partner associated with the company. This is required to specify the scope of the request. |
Company Id | The unique identifier of the company whose usage data is being requested. This is required to identify the target company. |
Output
The node outputs JSON data containing the usage details of the specified company. The exact structure depends on the API response from AvantGuard Phin Security but typically includes metrics related to the company's usage statistics within the partner's context.
If the API supports binary data (e.g., reports or logs), it would be included in the binary output; however, based on the static code and properties, the primary output is JSON-formatted usage data.
Dependencies
- Requires an active AvantGuard Phin Security API key credential configured in n8n.
- Depends on the external AvantGuard Phin Security REST API endpoint at
https://api.phinsec.io
. - Uses standard HTTP headers for JSON content negotiation (
Accept: application/json
,Content-Type: application/json
).
Troubleshooting
- Missing or invalid Partner Id / Company Id: Ensure both IDs are correctly provided and valid; otherwise, the API will likely return an error or empty results.
- Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
- Network issues or API downtime: Check connectivity to
https://api.phinsec.io
and confirm the service status. - Unexpected API responses: If the output JSON structure changes, update downstream processing accordingly.
Links and References
- AvantGuard Phin Security API Documentation (assumed base URL, consult official docs for detailed endpoints)
- n8n documentation on API credentials setup