> ## 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.

# Overe API

> Work Overe from Neo: read a customer's posture, GSO tasks, policy drift and identity alerts on Microsoft 365 security tickets, and sign a user out or block the account with approval

The common use is a Microsoft 365 security, identity or alert ticket, where the agent reads the customer's Overe alert, the user's sign-ins, the posture score, the failed controls and the open GSO tasks, and writes the technician a note on what failed, how severe it is and the fix. With a technician's approval it signs the user out or blocks the account.

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

## What It Does

* Read a site's posture score and its history, the controls that failed, and where the posture drifted
* Read the Action Hub's prioritised GSO tasks and the latest Deep Scan with its findings
* Read alerts with their evidence, the alert types, and sign-in statistics
* Read users with their MFA and sign-in state, devices, groups, roles and enterprise apps, and the Conditional Access gaps per user
* Sign a user out of every session, and block or unblock the account
* Change an alert's status, close or snooze a GSO task, start a Deep Scan
* Manage sites, policies and templates, exclusions, auto-response, notifications and members

## Permission Groups

| Group | Covers |
| - | - |
| Organization & Members | Your organization, members, invites, client apps and branding |
| Sites | Your customer sites, their overview and company profile |
| Microsoft 365 Connections | Each site's tenant connection, its tenant id and domains, syncs and onboarding |
| Posture & Deep Scans | Posture scores, control reports, Deep Scans with GSO findings, and reports |
| Policies & Templates | Each site's policies and controls, and the policy templates |
| Conditional Access Analysis | The Conditional Access gaps of a tenant (read only) |
| Identities & Devices | Users, devices, groups, roles, enterprise apps and branding (read only) |
| Sign-out & Account Block | Signing a user out and blocking or unblocking the account |
| Alerts & Sign-ins | Alerts, alert types and sign-in statistics; changing an alert's status |
| Exclusions & Custom Rules | Alert exclusions, Deep Scan exclusion profiles and custom alert rules |
| Auto-Response | The sign-out and block Overe runs on its own when an alert fires |
| Action Hub (GSO Tasks) | Prioritised security tasks; closing and snoozing them |
| Notifications & HaloPSA Connector | Notification settings, the webhook, notification rules and Overe's HaloPSA connector |
| Billing | Subscription, enablements, billing contact and billing report |

## Access Profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read | No write is allowed |
| **Helpdesk** | Every read | Signing out, blocking, and alert and GSO task changes; no other write is allowed |
| **IT Admin** | Every read; signing out and blocking, alerts, GSO tasks, posture and tenant connections | Exclusions, auto-response, policies, sites, members and notifications, and the changes in Safety Controls |
| **Full Automation** | Every read and write but billing, outside Safety Controls | The changes in Safety Controls |

## Safety Controls

| Control | Behavior |
| - | - |
| **The ticket's customer only** | On a run for a ticket that names a company, Neo sends a call only when it names the Overe site the ticket's company is mapped to: in its path, or in `site_ids` on the Action Hub task list. Calls about your whole organization (the site list, policy templates, notification and auto-response rules, billing) are refused there |
| **Your organization only** | Neo adds your organization to every path, so an agent cannot reach another organization |
| **Always asks a technician** | Every change that stops Overe protecting a customer: deleting a site, disconnecting its Microsoft 365 tenant or ending its trial, turning a policy or one of its controls off (anything short of Enforced), assigning a policy template to a site, writing, changing or removing an auto-response, and unblocking an account. So does a change that grants access to your organization (a member's role, an invite, accepting one) or changes or silences where alerts go (email recipients, removing the webhook, notification rules, adding, pausing or removing the HaloPSA connector, removing its mappings). Alert exclusions and custom rules follow the group's approval setting, as every other change does |
| **Refused** | Deleting your organization, creating a client app, reading or deleting one, uploading a branding image, the subscription's payment pages, and changing the webhook settings, the HaloPSA connector or its mappings. Those three records hold a secret that Neo hides, so a change from Neo could erase it; change them in the Overe portal |
| **Secrets** | Every secret field in an answer, such as the HaloPSA connector's client secret, an API key or a token, is hidden, and a change that would send the hidden placeholder back is refused, so the stored secret stays as it was |


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