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

# 8x8 API

> Create, change and deactivate users in your clients' 8x8 accounts, manage ring groups, and read sites, numbers, contacts and the audit log

The common uses are staff onboarding and offboarding: when a new starter's ticket arrives, the agent creates their 8x8 user with a site, licence, extension and number, and adds them to their team's ring groups; when someone leaves, it deactivates them and takes them out of ring groups.

> [!NOTE]
>
> Automatically enabled when you configure 8x8 permissions in your agent workflow. 8x8 is connected per client, so the agent calls the 8x8 account of the ticket's company.

## What it does

* Find users, and create, change, deactivate and delete them, with their licences, extensions, numbers and user group
* Create, update and deactivate users through SCIM, on a client connected with SCIM
* Add, reorder and remove ring group members, and create and delete ring groups
* Read the account's phone numbers, free ones included; create, change and delete sites; and create and delete addresses
* Search, create, change and delete the company directory's shared contacts
* Read the Admin Console audit log

8x8's Administration API answers each change to a user, ring group, site or address with an operation, and the agent reads it until 8x8 reports the change complete or failed. It reports such a change as done only after that. A SCIM or directory contact change answers with its result directly.

Neo reads a record before it updates it and keeps every field the agent leaves out, because 8x8 replaces the whole record on an update. A device's activation code, and any PIN, password or token in an answer, reaches the agent as `[redacted by Neo]`. The agent cannot send that placeholder back, filter or sort on such a field, or set or clear a PIN, password or token, such as a ring group's voicemail PIN; a technician changes those in 8x8 Admin Console. Ring group settings other than members are changed in Admin Console too, because 8x8 never returns the voicemail PIN that a full ring group update would reset.

## Permission groups

| Group | Access levels | Covers |
| - | - | - |
| Users | Disabled, Read Only, Read / Write | Users with their licences, extensions, numbers, devices and memberships, through the Administration API and SCIM; create, update, deactivate and delete a user |
| Ring Groups | Disabled, Read Only, Read / Write | Ring groups and their members; create and delete a ring group, and add, reorder and remove its members |
| Sites, Addresses & Numbers | Disabled, Read Only, Read / Write | Sites with their dial plan and emergency settings, their addresses, and the account's phone numbers; create, change and delete a site; create and delete an address |
| Directory Contacts | Disabled, Read Only, Read / Write | Shared contacts in the company directory; create, change and delete a contact |
| Audit Log | Disabled, Read Only | Who created, changed or deleted users, ring groups and other records in Admin Console, and when |

Reading the state of a change needs any one of these groups. Deleting a site always asks a technician, whatever the group's approval setting, because a site holds users, numbers and emergency calling settings.

## Access profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read | No write is allowed |
| **Helpdesk** | Every read | Every user and ring group change; sites, numbers and contacts are read only |
| **IT Admin** | Every read, and every change except sites and addresses | Creating, changing or deleting a site, and creating or deleting an address |
| **Full Automation** | Every supported call except deleting a site | Deleting a site |


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