Phin Security n8n Node

The Phin Security API allows partners to access their data programmatically. It provides endpoints for managing companies, retrieving historical phishing and training data, accessing reporting artifacts, and viewing usage information. The API must be enabled through the Phin Portal. Authentication uses OAuth2 Client Credentials flow via Auth0.

Table of Contents

• Installation
• Authentication
• Resources & Operations
• Compatibility
• License

Installation

Follow the n8n community node installation guide.

Or install directly via npm:

npm install @avantguardllc/n8n-nodes-phinsecurity

Authentication

This node authenticates using OAuth 2.0.

| Setting | Value | |---------|-------| | Type | OAuth2 | | Flow | clientCredentials | | Token URL | https://phin.us.auth0.com/oauth/token | | Base URL | https://api.phinsec.io (editable in credentials) |

Tip: The Base URL can be changed in the credential settings if your instance uses a different host.

Resources & Operations

Base URL: https://api.phinsec.io

Authentication

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /oauth/token | Get access token |

Test

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /partners/{partnerId}/test | Test API access |

Companies

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /partners/{partnerId}/inventory | Get companies in Phin | | 🟢 POST | /partners/{partnerId}/companies | Create a company for a partner |

Usage

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /partners/{partnerId}/billing/usage | Get usage for a partner | | 🔵 GET | /partners/{partnerId}/companies/{companyId}/billing/usage | Get usage for a company |

HistoricalData

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /partners/{partnerId}/companies/{companyId}/historical-data | Get historical data for a company |

Reports

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /partners/{partnerId}/companies/{companyId}/reports | Get list of reporting artifacts for a company | | 🔵 GET | /partners/{partnerId}/companies/{companyId}/report/{reportPath} | Get a specific report for a company |

Users

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /partners/{partnerId}/companies/{companyId}/users/import | Import users into a company | | 🟡 PUT | /partners/{partnerId}/companies/{companyId}/users/sleep | Sleep users in a company |

Compatibility

• n8n version: 1.0+ (tested on 2.x)
• Node.js version: 18+

License

MIT