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 Actions
- Companies Actions
- Usage Actions
- HistoricalData Actions
- Reports Actions
- Users Actions
Users → Sleep users in a company
AI-generatedSummary
Sleep up to 100 users at a time via the Phin API. Users who do not exist or are already slept will not be updated. Sleeping a user removes them from active phishing and training campaigns.
Inputs
- partnerId (required) — Your Phin Partner ID
- companyId (required) — The Company ID
- userEmails (required) — Array of email addresses of users to sleep (maximum 100)
- options — Optional configuration for custom body JSON (deep-merged with userEmails, custom body values take priority), custom HTTP headers, query-string filters, and batching settings (items per batch and interval between batches). Debug mode can include request details in the output.
Output shape
array
Array of JSON responses from the API, or debug entries if enabled. One response per input item, respecting batching intervals.