Phin Security icon

Phin Security

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.

Actions10

Test → Test API access

AI-generated

Summary

Tests API access for the Phin Security integration by verifying OAuth2 token acquisition and partner ID validity against the GET /partners/{partnerId}/test endpoint.

Inputs

  • partnerId (required) — Your Phin Partner ID

Output shape

Single JSON item containing the API response body when returnAll is disabled; array of all items across pages when returnAll is enabled.

If debug is enabled and returnAll is disabled, an additional item {json: { debug: debugLog }} is appended. If debug is enabled and returnAll is enabled, the debug log is prepended as __debugLog.

Examples

Example 1: Verify integration with minimal configuration

Set partnerId to your Phin Partner ID; leave returnAll, debug, and other options at defaults. The node makes one GET request and returns the response.

Example 2: Fetch all test entries with pagination

Set returnAll to true. The node uses offset pagination by default (page parameter starting at 1, incrementing by 1, page size 50). Returns an array of all items. Adjust pageParam, startValue, increment, pageSize, sizeParam, maxPages, and requestInterval via the pagination settings to control behavior.

Links

Discussion