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

# Bluebeam API

> Create, deactivate and delete users in your clients' Bluebeam accounts, and assign, change and free their Revu plans through the plan groups

The common uses are staff onboarding and offboarding: after the agent creates a new hire's Microsoft 365 account, it creates their Bluebeam user and assigns their Revu plan; when someone leaves, it frees their plan and deactivates them.

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

## What it does

* Find a user by email, list the account's users, and read who belongs to each plan group
* Create a user, change their name, deactivate or reactivate them, and delete them
* Assign, change and free a plan by adding a user to a plan group and taking them out
* Create, rename and delete plan groups, when you turn that permission on

## How the agent onboards a user

The agent looks the person up first, and reactivates a deactivated user instead of creating a second one. It creates the user with their sign-in email, finds the plan group the ticket names, such as Bluebeam Core, and adds the user to it. It then reads the group to confirm. To change a plan, it adds the user to the new group before it takes them out of the old one, because Bluebeam deactivates a user who has no plan group left.

## How the agent offboards a user

The agent takes the user out of their plan group, which frees the plan, and deactivates them, which keeps their history. It deletes the user only when the request says to delete the account.

## Permission groups

| Group | Access levels | Covers |
| - | - | - |
| Users | Disabled, Read Only, Read / Write | The account's users with their name, email, status and plan groups; create, update, deactivate and delete a user |
| Plans & Licences | Disabled, Read Only, Read / Write | Plan groups and their members; add a user to a plan group and take them out, which assigns and frees that plan |
| Plan Groups | Disabled, Read Only, Read / Write | Create, rename and delete a plan group. Org Admin maps each group to a plan. Replacing or deleting a group changes its members, so it needs Plans & Licences at Read / Write too |

A request that changes a group's members and renames it at once is refused: the agent sends them as two requests, so each approval shows one kind of change.

These always ask a technician, whatever the group's setting, because one request can take many users' plans or clear fields nobody named:

* replacing a whole user or group (a PUT);
* replacing a plan group's member list, or a removal from it that names no single member, which removes every member;
* deleting a plan group, which deactivates every member who has no other plan group.

## Access profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read | No write is allowed |
| **Helpdesk** | Every read | Creating, changing, deactivating or deleting a user, and assigning or freeing a plan; plan groups are read only |
| **IT Admin** | Every read, and user and plan changes | Creating, renaming or deleting a plan group |
| **Full Automation** | Every supported call | Only the writes above that always ask |


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