> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Phin Security API

> Read and manage Phin Security from Neo: the reporter's phishing and training record on a phishing ticket, users, campaigns and reports

The common use is a reported phishing ticket in your PSA: the agent finds the user who reported the email in the customer's Phin company, reads their phishing and training record and the company's active campaigns, and writes an internal note with the next step it recommends and why. Agents also add and remove users on onboarding and offboarding tickets.

> [!NOTE]
>
> Automatically enabled when you configure Phin Security permissions in your agent workflow.

## What It Does

* Read your companies, a company's active user count, and its users with their status, department and manager
* Read each user's phishing simulations sent and clicked and trainings assigned and completed over the last 12 months
* Read a company's active phishing and training campaigns and the list of its generated reports
* Read billable and enrolled users for your partner and each company
* Import users, edit a user, sleep or delete users, add a company admin, and create a company

Neo does not download report files (PDF or CSV): the agent gives the technician each report's name and link.

## Permission Groups

| Group | Covers |
| - | - |
| Companies | Your companies; creating a company |
| Users | A company's users; import, edit, sleep and delete |
| Campaigns and Results | Active campaigns, per-user phishing and training results, reports |
| Company Admins | Adding a company admin |
| Billing Usage | Billable and enrolled users |

## Access Profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read | Nothing: Neo changes nothing in Phin |
| **Helpdesk** | Every read | Every write |
| **IT Admin** | Reads, and user imports, edits, sleeps and deletes | A new company or company admin |
| **Full Automation** | Everything | Nothing |

## Safety Controls

| Control | Behavior |
| - | - |
| **The ticket's customer only** | On a run for a ticket that names a company, Neo sends a call only for the Phin company that company is mapped to, and refuses the list of every company, a new company and partner-wide billing |
| **Your partner only** | Neo writes your saved Partner ID into every call, so no call can name another partner |
| **One user per edit** | A single-user edit whose body names another user than its path is refused before approval |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.