# UniFi On Prem MCP connector

The UniFi On Prem connector lets Claude, ChatGPT, Cursor, or any MCP client manage the people in your UniFi access system, creating users, assigning NFC cards, PIN codes, touch passes, license plates, and access policies, with every change logged.

Source: https://elaichi.ai/connectors/unifionprem/

## Facts

| | |
| --- | --- |
| Application | UniFi On Prem |
| Category | Security |
| AI tools | 109 |
| Authentication | Connects with an API key |
| Needs your own OAuth app | No |
| MCP endpoint | https://api.elaichi.ai/mcp |
| Works with | Claude, ChatGPT, Cursor, any MCP client, and the Elaichi Agent |
| Tools advertised by name | No. 109 tools is past the 30-tool threshold, so clients use `search_tools` and `execute_tool` |

## What you can ask once UniFi On Prem is connected

- List all UniFi On Prem users without an access policy.
- Assign a PIN code to the new warehouse contractor.
- Which users still hold NFC cards after leaving?

## Connect UniFi On Prem in Elaichi

This happens once for the organization, before any client is involved.

1. Open Connections, choose Add connection, and pick UniFi On Prem.
2. Optionally set Share with, then press Connect.
3. Paste an UniFi On Prem API key. One person generates a token in UniFi On Prem and pastes it once. Everyone else works through Share with, and never sees it.

Credentials are vaulted and nobody, including the AI, reads them back. The connection becomes a toolbox immediately, so you can curate which UniFi On Prem tools are exposed, rename them, or freeze arguments before anyone points a client at it.

## Connect UniFi On Prem to Claude

Endpoint: https://api.elaichi.ai/mcp

1. Open Customize, then Connectors.
2. Press Add.
3. Name it, paste the MCP server URL, then Continue.
4. Sign in and approve.

On Team and Enterprise, an Owner adds it once. Everyone else turns it on for themselves.

## Connect UniFi On Prem to ChatGPT

Endpoint: https://api.elaichi.ai/mcp

1. Open Plugins, then press the + button.
2. Name it and paste the endpoint into Server URL.
3. Leave Authentication on OAuth, then tick the risk acknowledgement.
4. Press Create, then sign in and approve.

Works on the web today. The plugin directory lives at chatgpt.com/plugins.

## Connect UniFi On Prem to Cursor

Endpoint: https://api.elaichi.ai/mcp

1. Open `~/.cursor/mcp.json`.
2. Add the endpoint under `mcpServers`.
3. Reload Cursor, then sign in and approve.

Set up per machine, so repeat it on each computer you work from.

## Connect UniFi On Prem to any MCP client

Endpoint: https://api.elaichi.ai/mcp

1. Add the endpoint as a remote MCP server.
2. Sign in and approve.

The Elaichi Agent already has these tools, with nothing to set up.

## What the consent screen decides

Only Read is granted by default, which is not enough to call a UniFi On Prem tool. Over MCP there is no trusted place to confirm a write in the moment, so the consent screen is the standing approval rather than a formality. Grant Read and Run tools. Think hard before granting Delete, which reaches into connected apps and cannot be undone.

## What teams do with UniFi On Prem through Elaichi

### Set up building access on day one

HR. Create the new hire as a UniFi On Prem user, add them to the right user group, and assign their access policy and PIN code before they walk in on Monday.

### Replace a lost badge in seconds

Facilities. Unassign the missing NFC card from the person's UniFi On Prem user and assign the new one, without opening the controller or waiting for IT.

### Check who can open which doors

Security. Ask which access policies a UniFi On Prem user holds, or list everyone in a user group, before an audit or right after a change.

### Register a contractor's license plate for parking

Office management. Assign the plate to the contractor's UniFi On Prem user for the week and remove it when the job ends, so the gate stops recognizing it.

### Move a whole team to phone entry

IT. Batch assign touch passes to a department's UniFi On Prem users in one go instead of handling each person individually.

### Revoke access the moment someone leaves

Security. Unassign the departing employee's PIN code, NFC card, touch pass, and license plate in UniFi On Prem, or delete their user entirely, before they reach the parking lot.

## Frequently asked questions

### How do I connect UniFi On Prem to Claude?

Two steps. In Elaichi, pick UniFi On Prem from the connector catalog and paste in the API key from your UniFi controller, there is no OAuth application to register and no client ID or secret to generate. Then in Claude open Customize, then Connectors, then Add, and paste https://api.elaichi.ai/mcp. Sign in with your Elaichi account and UniFi On Prem is ready to use.

### Does UniFi On Prem work with ChatGPT and Cursor as well as Claude?

Yes. Once UniFi On Prem is connected in Elaichi, the same endpoint, https://api.elaichi.ai/mcp, works in Claude, ChatGPT, Cursor, any other MCP client, and the Elaichi Agent. You connect UniFi On Prem once and every client picks it up.

### What can an AI agent actually do with my UniFi On Prem data?

An agent can create and update UniFi On Prem users, search for a person, upload their profile picture, and put them in the right user group. It can assign or remove NFC cards, PIN codes, touch passes, license plates, and access policies, and tell you which policies someone currently holds. Because UniFi On Prem has a lot of actions, short concrete asks like "assign a PIN to Maria Lopez" work better than long paragraphs.

### Does connecting UniFi On Prem give the AI control of every door and every user?

No. Every call to UniFi On Prem runs inside the access of the person who signed in, so the AI can only see and change the users, groups, and policies that person could already manage. Elaichi can narrow that further with restrictions, but it never widens it beyond what UniFi On Prem itself allows that person.

### Can my team share one UniFi On Prem connection?

Yes. One person connects UniFi On Prem in Elaichi with the API key and shares the connection with a team, and nobody else ever handles the key. Each teammate still signs in to Elaichi as themselves, so the audit log names the actual person who assigned a badge or changed an access policy.

### Can I stop an agent from deleting or changing things in UniFi On Prem?

Yes. Restrictions in Elaichi work per action, so you can allow searching and listing UniFi On Prem users while blocking deletion, or blocking changes to access policies. A blocked action is never advertised to Claude, ChatGPT, or any other client, so no prompt can reach it.

### What happens to a UniFi On Prem connection when someone leaves?

Offboarding that person in Elaichi ends their access to UniFi On Prem through every client at once. A shared UniFi On Prem connection keeps working for everyone else on the team. If you ever want to remove UniFi On Prem entirely, disconnecting it once in Elaichi removes it from Claude, ChatGPT, Cursor, and every other client.

## All 109 UniFi On Prem tools

Every tool below is callable through https://api.elaichi.ai/mcp once UniFi On Prem is connected, subject to the toolbox it is in and the restrictions on the caller.

- **Create a UniFi On Prem user** (Create). Register a new user in UniFi Access. Returns the created user object including its id, first_name, last_name, user_email, employee_number, onboard_time, status, and assigned access policies. Required: first_name, last_name.
- **Update a UniFi On Prem user by ID** (Update). Update a user's details in UniFi Access by id. Returns the updated user object including its id, first_name, last_name, user_email, employee_number, onboard_time, status, and assigned access policies. Required: id.
- **Get single UniFi On Prem user by ID** (Get). Get a single UniFi Access user by id. Returns the full user object including its id, first_name, last_name, user_email, employee_number, onboard_time, status, access policies, NFC cards, license plates, PIN code, and touch pass. Required: id.
- **List all UniFi On Prem users** (List). List all UniFi Access users with pagination. Returns each user's id, first_name, last_name, user_email, employee_number, onboard_time, status, access policies, NFC cards, license plates, PIN code, and touch pass. Optional: expand to include access policies.
- **UniFi On Prem users assign access policy** (Assign). Assign or replace access policies for a UniFi Access user. Pass an array of access policy IDs to set the user's assigned policies; pass an empty array to remove all policies. Returns an empty 204 response on success. Required: user_id, access_policy_ids.
- **UniFi On Prem users assign nfc card** (Assign). Assign an NFC card to a UniFi Access user by providing the card token. Use force_add to overwrite a card already assigned to another user. Returns a success confirmation with no data payload. Required: user_id, token.
- **UniFi On Prem users unassign nfc card** (Action). Unassign an NFC card from a UniFi Access user by providing the card token. Returns a success confirmation with no data payload. Required: user_id, token.
- **UniFi On Prem users assign pin code** (Assign). Assign a PIN code to a UniFi Access user for unlocking doors. Returns a success confirmation with no data payload. Required: user_id, pin_code.
- **UniFi On Prem users unassign pin code** (Action). Unassign the PIN code from a UniFi Access user. Returns a success confirmation with no data payload. Required: user_id.
- **UniFi On Prem users list access policies** (List). List the access policies assigned to a UniFi Access user, including policies inherited from the user's group unless filtered. Returns: id, name, resources, schedule_id. Required: user_id.
- **Delete a UniFi On Prem user by ID** (Delete). Delete a UniFi Access user by id. Returns an empty 204 response on success. Required: id.
- **UniFi On Prem users search** (Search). Search UniFi Access users. Returns matching user records including id, first_name, last_name, full_name, email, user_email, status, email_status, alias, avatar_relative_path, employee_number, nfc_cards, onboard_time, phone, pin_code, and username.
- **UniFi On Prem users assign touch pass** (Assign). Assign a suspended or inactive Touch Pass to a specific user in UniFi Access. Returns the Touch Pass object including id, card_id, status, user_id, user_name, and user_email. Required: user_id, touch_pass_id. Requires UniFi Access version 3.2.20 or later.
- **UniFi On Prem users unassign touch pass** (Action). Unassign a Touch Pass from a specific user in UniFi Access. Returns the Touch Pass object with id, card_id, card_name, status, last_activity, bundles, and user fields after unassignment. Required: user_id. Requires UniFi Access version 3.2.20 or later.
- **UniFi On Prem users batch assign touch passes** (Assign). Batch assign unassigned Touch Passes to users in UniFi Access using their email addresses. Returns an array of Touch Pass objects with id, card_id, card_name, status, last_activity, bundles, and user assignment details. Required: ids. Requires UniFi Access version 3.2.20 or later.
- **UniFi On Prem users assign license plate** (Assign). Assign one or more license plate numbers to a specific user in UniFi Access. Returns an empty response on success. Required: user_id. UniFi Access version 3.3.10 or later is required.
- **UniFi On Prem users unassign license plate** (Action). Unassign a specific license plate number from a user in UniFi Access. Returns an empty response on success. Required: user_id, license_plate_id. UniFi Access version 3.3.10 or later is required.
- **UniFi On Prem users upload profile picture** (Upload). Upload a profile picture for a user in UniFi Access. Returns: avatar_url. Required: user_id. Only supported for local users; UI Account users must update their picture through the UI Account interface. UniFi Access version 3.3.10 or later is required.
- **Create a UniFi On Prem user group** (Create). Create a new user group in UniFi Access. Returns: id. Required: name.
- **List all UniFi On Prem user groups** (List). List all user groups in UniFi Access. Returns: id, name, full_name, up_id, up_ids.
- **Get single UniFi On Prem user group by ID** (Get). Get a single user group by id in UniFi Access. Returns: id, name, full_name, up_id, up_ids. Required: id.
- **Update a UniFi On Prem user group by ID** (Update). Update a user group by id in UniFi Access. Returns: id, name, full_name, up_id, up_ids. Required: id, name.
- **Delete a UniFi On Prem user group by ID** (Delete). Delete a user group by id in UniFi Access. Returns an empty 204 response on success. Required: id.
- **UniFi On Prem user groups assign user** (Assign). Assign users to a user group in UniFi Access by supplying an array of user identity IDs in the request body. Returns a success confirmation with no data payload. Required: user_group_id.
- **UniFi On Prem user groups unassign user** (Action). Remove users from a user group in UniFi Access by supplying an array of user identity IDs in the request body. Returns a success confirmation with no data payload. Required: user_group_id.
- **UniFi On Prem user groups list all users** (List). List all users across UniFi on-premises user groups, including users in subgroups. Returns: id, first_name, last_name, full_name, email, user_email, status, email_status, employee_number, phone, username, alias, avatar_relative_path, onboard_time.
- **UniFi On Prem user groups assign access policy** (Assign). Assign access policies to a UniFi on-premises user group by providing the access policy IDs. Returns an empty 204 response on success. Required: user_group_id, access_policy_ids.
- **UniFi On Prem user groups list access policies** (List). List the access policies assigned to a user group in UniFi Access. Returns each policy's id, name, resources (door groups and doors), and schedule_id. Required: user_group_id.
- **Create a UniFi On Prem visitor** (Create). Create a new visitor in UniFi Access with personal details, visit schedule, and door access resources. Returns: id, first_name, last_name, status, schedule_id, resources, nfc_cards, license_plates, pin_code, schedule. Required: first_name, last_name.
- **Get single UniFi On Prem visitor by ID** (Get). Get a single UniFi Access visitor by id. Returns: id, first_name, last_name, status, schedule_id, resources, nfc_cards, license_plates, pin_code, schedule. Required: id.
- **List all UniFi On Prem visitors** (List). List all visitors in UniFi Access. Returns: id, first_name, last_name, status, schedule_id, resources, nfc_cards, license_plates, pin_code, schedule. Supports optional status filtering, keyword prefix search on visitor names, and expandable related objects.
- **Update a UniFi On Prem visitor by ID** (Update). Update a visitor in UniFi Access by id. Returns: first_name, id, last_name, nfc_cards, license_plates, pin_code, resources, schedule, schedule_id, status. Required: id. Status change is not supported.
- **Delete a UniFi On Prem visitor by ID** (Delete). Delete a visitor in UniFi Access by id. If the is_force query parameter is set, physically deletes the visitor; otherwise updates the visitor to canceled status. Returns an empty 204 response on success. Required: id.
- **UniFi On Prem visitors assign nfc card** (Assign). Assign an NFC card to a visitor in UniFi Access by providing the card token. Returns a success response with no data payload. Required: visitor_id, token.
- **UniFi On Prem visitors unassign nfc card** (Action). Unassign an NFC card from a visitor in UniFi Access by providing the card token. Returns a success response with no data payload. Required: visitor_id, token.
- **UniFi On Prem visitors assign pin code** (Assign). Assign a PIN code to a UniFi Identity visitor so the visitor can unlock doors. The PIN code must first be generated via the /api/v1/developer/pin_codes endpoint. Returns a success response with no data payload. Required: visitor_id, pin_code.
- **UniFi On Prem visitors unassign pin code** (Action). Unassign the PIN code from a visitor in UniFi Access. Returns an empty 204 response on success. Required: visitor_id.
- **UniFi On Prem visitors assign qr code** (Assign). Assign a QR code to a visitor in UniFi Access. Returns an empty 204 response on success. Required: visitor_id. UniFi Access version 3.3.10 or later required.
- **UniFi On Prem visitors unassign qr code** (Action). Unassign (remove) a QR code from a visitor in UniFi Access. Returns an empty 204 response on success. Required: visitor_id. UniFi Access version 3.3.10 or later required.
- **UniFi On Prem visitors assign license plate** (Assign). Assign one or more license plate numbers to a visitor in UniFi Access. Returns an empty 204 response on success. Required: visitor_id and a request body containing a list of license plate numbers. UniFi Access version 3.3.10 or later required.
- **UniFi On Prem visitors unassign license plate** (Action). Unassign a license plate number from a visitor in UniFi Access. Returns an empty 204 response on success. Required: visitor_id, license_plate_id. UniFi Access version 3.3.10 or later required.
- **Create a UniFi On Prem access policy** (Create). Create a new access policy in UniFi Access. Returns: id. Required: name, schedule_id.
- **Update a UniFi On Prem access policy by ID** (Update). Update a UniFi access policy by id, modifying only the fields supplied in the request body. Returns the string 'success' confirming the update. Required: id. All body fields (name, resource, schedule_id) are optional — omit any that do not need to change.
- **Delete a UniFi On Prem access policy by ID** (Delete). Delete a UniFi access policy by id. Returns an empty 204 response on success. Required: id.
- **Get single UniFi On Prem access policy by ID** (Get). Get a single UniFi Access access policy by id. Returns: id, name, resources, schedule_id. Required: id.
- **List all UniFi On Prem access policies** (List). List all UniFi Access access policies. Returns each policy with id, name, resources (doors and door groups), and schedule_id.
- **Create a UniFi On Prem holiday group** (Create). Create a new holiday group in UniFi Access with a name and an optional list of holidays. Returns the created holiday group including its id, name, description, is_default, template_name, and holidays array. Required: name.
- **Update a UniFi On Prem holiday group by ID** (Update). Update a holiday group in UniFi Access by id, including its name, description, and holidays. Returns the updated holiday group including its id, name, description, is_default, template_name, and holidays array. Required: id, name.
- **Delete a UniFi On Prem holiday group by ID** (Delete). Delete a holiday group in UniFi Access by id. Returns a success confirmation string. Required: id.
- **Get single UniFi On Prem holiday group by ID** (Get). Get a UniFi Access holiday group by id. Returns: id, name, is_default, description, holidays, template_name. Required: id.
- **List all UniFi On Prem holiday groups** (List). List all holiday groups in UniFi Access. Returns: id, name, description, count.
- **Create a UniFi On Prem schedule** (Create). Create a door access schedule in UniFi Access. Returns the created schedule including its id, name, type, is_default, weekly schedule, holiday_group_id, holiday_group, and holiday_schedule. Required: name, week_schedule.
- **Update a UniFi On Prem schedule by ID** (Update). Update a door access schedule in UniFi Access by id. Returns the updated schedule including its id, name, type, is_default, weekly schedule, holiday_group_id, holiday_group, and holiday_schedule. Required: id.
- **Get single UniFi On Prem schedule by ID** (Get). Fetch a door access schedule in UniFi Access by id. Returns the schedule including its id, name, type, is_default, weekly schedule, holiday_group_id, holiday_group, and holiday_schedule. Required: id.
- **List all UniFi On Prem schedules** (List). List all door access schedules in UniFi Access on-premises. Returns each schedule with id, name, type, is_default, status, holiday_group_id, weekly time slots, holiday_group, and holiday_schedule.
- **Delete a UniFi On Prem schedule by ID** (Delete). Delete a door access schedule in UniFi Access on-premises by id. Returns an empty 204 response on success. Required: id.
- **UniFi On Prem credentials generate pin code** (Generate). Generate a new PIN code in UniFi Access for unlocking doors. Returns the generated PIN code as a string, which can then be assigned to a user or visitor via the pin_codes assignment endpoints. The PIN code length must meet the system's preset requirements.
- **UniFi On Prem credentials enroll nfc card** (Action). Create an NFC card enrollment session by waking up a UA reader in UniFi Access. Returns: session_id. Required: device_id.
- **UniFi On Prem credentials get nfc enrollment status** (Get). Poll a UniFi Access UA reader to fetch the NFC card enrollment status and generated card tokens for a given session. Returns: card_id, token. Required: session_id. This is a polling endpoint — until enrollment completes the response data may be a simple status string rather than the card_id/token object.
- **UniFi On Prem credentials delete nfc enrollment session** (Delete). Delete an NFC card enrollment session in UniFi Access. Returns an empty 204 response on success. Required: session_id.
- **UniFi On Prem credentials download qr code image** (Download). Download a QR code image for a credential in UniFi Access. Returns: card_id, token. Required: qr_code_id.
- **Get single UniFi On Prem nfc card by ID** (Get). Get a single NFC card in UniFi Access by its token. Returns: token, display_id, status, alias, card_type, note, user_id, user_type, user. Required: id.
- **List all UniFi On Prem nfc cards** (List). List all NFC cards in UniFi Access, optionally filtered by alias. Returns: token, display_id, status, alias, card_type, note, user_id, user_type, user. Optional: alias.
- **Delete a UniFi On Prem nfc card by ID** (Delete). Delete an NFC card in UniFi Access by its token. Returns a success confirmation. Required: id.
- **Update a UniFi On Prem nfc card by ID** (Update). Update an NFC card in UniFi Access. Returns the updated card object including token, display_id, status, alias, card_type, note, user_id, user_type, and user. Required: id. Requires UniFi Access version 3.1.30 or later.
- **UniFi On Prem nfc cards import third party** (Import). Import third-party NFC card IDs into UniFi Access by uploading a CSV file. Returns an array of imported card records, each containing alias, nfc_id, and token. An empty token indicates the import failed for that record. Required: file (CSV with NFC IDs in uppercase hexadecimal and optional unique aliases). Duplicate aliases cause the import to fail. Requires UniFi Access v3.3.10 or later.
- **List all UniFi On Prem touch passes** (List). List all Touch Passes in UniFi Access, optionally filtered by status. Returns: id, card_id, card_name, status, last_activity, activated_at, expired_at, user_id, user_name, user_email, user_status, user_avatar, bundles.
- **UniFi On Prem touch passes search** (Search). Search Touch Passes in UniFi Access by a condition such as card ID or user name. Returns: id, card_id, card_name, status, last_activity, activated_at, expired_at, user_id, user_name, user_email, user_status, user_avatar, bundles. Required: condition. Requires UniFi Access version 3.2.20 or later.
- **UniFi On Prem touch passes list assignable** (List). List all suspended or inactive Touch Passes available for reassignment in UniFi Access. Returns: id, card_id, card_name, status, last_activity, activated_at, expired_at, user_id, user_name, user_email, user_status, user_avatar, bundles. Requires UniFi Access version 3.2.20 or later.
- **Update a UniFi On Prem touch pass by ID** (Update). Update a Touch Pass in UniFi Access by modifying its card name, changing its status (ACTIVE or SUSPENDED), or unbundling devices. Returns: id, card_id, card_name, status, activated_at, expired_at, last_activity, user_id, user_name, user_email, user_avatar, user_status, bundles. Required: id.
- **Get single UniFi On Prem touch pass by ID** (Get). Get detailed information about a specific Touch Pass in UniFi Access by id. Returns: id, card_id, card_name, status, activated_at, expired_at, last_activity, user_id, user_name, user_email, user_avatar, user_status, bundles. Required: id.
- **UniFi On Prem touch passes purchase** (Action). Purchase new Touch Passes in UniFi Access. Returns the purchased pass object including id, card_id, card_name, status (INACTIVE), last_activity, bundles, and unassigned user fields (user_id, user_name, user_email, user_avatar, user_status). Required: count. A valid payment method must be configured in the Access web application before using this API.
- **UniFi On Prem spaces get door group topology** (Get). Fetch the door group topology in UniFi Access, showing the hierarchical arrangement of door groups including the building (all doors) and custom access groups. Returns: id, name, type, resources.
- **Create a UniFi On Prem door group** (Create). Create a new door group in UniFi Access. Returns: id, type. Required: group_name, resources. The group name must be globally unique.
- **Get single UniFi On Prem door group by ID** (Get). Get a single UniFi Access door group by id. Returns: id, name, type, resources. Required: id.
- **Update a UniFi On Prem door group by ID** (Update). Update a UniFi Access door group by id. Returns: id, name, type, resources. Required: id.
- **List all UniFi On Prem door groups** (List). List all door groups in UniFi Access. Returns each group's id, name, type, and resources. The list does not include groups of type building.
- **Delete a UniFi On Prem door group by ID** (Delete). Delete a UniFi Access door group by id. Returns: success. Required: id.
- **Get single UniFi On Prem door by ID** (Get). Get a single UniFi Access door by id. Returns: id, name, full_name, type, door_lock_relay_status, door_position_status, floor_id, is_bind_hub. Required: id.
- **List all UniFi On Prem doors** (List). List all UniFi Access doors. Returns: id, name, full_name, type, door_lock_relay_status, door_position_status, floor_id, is_bind_hub.
- **UniFi On Prem doors remote unlock** (Action). Remotely unlock a UniFi Access door by door_id. Returns a success acknowledgment string confirming the door unlock. Required: door_id. If either actor_id or actor_name is provided, both must be included.
- **UniFi On Prem doors set temporary locking rule** (Set). Set a temporary locking rule for a UniFi Access door by door_id. Returns: type, ended_time. Required: door_id, type. UniFi Access 1.24.6 or later required.
- **UniFi On Prem doors get locking rule** (Get). Fetch the current locking rule for a UniFi Access door by door_id. Returns: type, ended_time. Required: door_id. UniFi Access 1.24.6 or later required.
- **UniFi On Prem doors set emergency status** (Set). Set the emergency status (lockdown and/or evacuation) for a specific door in UniFi Access. Returns a success acknowledgment string. Required: door_id.
- **UniFi On Prem doors get emergency status** (Get). Fetch the current emergency status for a specific door in UniFi Access. Returns: lockdown, evacuation. Required: door_id.
- **List all UniFi On Prem devices** (List). List UniFi Access devices. Returns: id, name, type, alias. Pass refresh=true to bypass the device cache and fetch real-time info (may be slower).
- **UniFi On Prem devices get access method settings** (Get). Fetch the current access method settings of a UniFi Access device. Returns: access_methods, device_id. Required: device_id. UniFi Access version 3.3.10 or later.
- **UniFi On Prem devices trigger doorbells** (Action). Trigger doorbells on UniFi Access intercom devices. Optionally specify an intercom directory name via room_name to target a specific intercom, or set cancel to true to stop a previously triggered doorbell that is still ringing. Returns a success acknowledgment (the string "success" or null) indicating the doorbell trigger request was accepted.
- **UniFi On Prem devices bulk update** (Update). Update the access method settings of a UniFi Access device, including NFC, Bluetooth tap/unlock/shake, PIN code, Face Unlock, QR code, and Touch Pass. Returns: access_methods, device_id. Required: device_id. Requires UniFi Access Version 3.3.10 or later.
- **List all UniFi On Prem system logs** (List). List UniFi Access system logs filtered by topic, with optional time-range and actor filters. Returns each log entry including actor, authentication, event, target, and tag. Required: topic.
- **UniFi On Prem system logs export** (Export). Export UniFi Access system logs to a CSV file filtered by topic and time range. Returns a success confirmation string. Required: topic, since, until, timezone. The since and until period cannot exceed one month.
- **UniFi On Prem system logs list resources** (List). List resources in UniFi On-Prem system logs, returning access-policy-style records with their associated door groups/doors and schedule assignments. Returns: id, name, resources, schedule_id.
- **UniFi On Prem system logs list static resources** (List). List static resource policies (door groups and doors) recorded in UniFi On-Prem system logs. Returns: id, name, resources (each with id and type), schedule_id.
- **UniFi On Prem identity send invitations** (Send). Send UniFi Identity invitations to invite users to join UniFi Identity in unifionprem. Returns an array of invitation results containing error_code, error_msg, user_email, and user_id for any failed invitations; an empty array indicates all invitations succeeded. Required: user_id and email for each invitation entry.
- **UniFi On Prem identity list available resources** (List). List available UniFi Identity resources in unifionprem grouped by type. Returns: ev_station, vpn, wifi. Accepts an optional resource_type filter.
- **UniFi On Prem identity assign user resources** (Assign). Assign UniFi Identity resources to a user in unifionprem by specifying a resource type and list of resource IDs. Returns an empty 204 response on success. Required: user_id, resource_type, resource_ids.
- **UniFi On Prem identity list user resources** (List). List the UniFi Identity access policies (resources) assigned to a specific user in unifionprem. Returns: id, name, resources, schedule_id. Required: user_id. Requires UniFi Access 1.24.6 or later.
- **UniFi On Prem identity assign group resources** (Assign). Assign UniFi Identity resources to a user group in unifionprem. Returns an empty response on success (data is null). Required: user_group_id, resource_type, resource_ids.
- **UniFi On Prem identity list group resources** (List). Fetch the UniFi Identity resources assigned to a user group in unifionprem. Returns: ev_station, vpn, wifi, camera. Required: user_group_id.
- **UniFi On Prem notifications fetch websocket** (Action). Fetch real-time notifications from UniFi Access via WebSocket, receiving events such as doorbell rings and doorbell status changes. Returns: channel, token, device_id, device_type, device_name, door_name, controller_id, floor_name, request_id, clear_request_id, in_or_out, create_time, reason_code, door_guard_ids, connected_uah_id, room_id, host_device_mac, remote_call_request_id. UniFi Access…
- **UniFi On Prem webhooks list events** (List). List supported webhook events in UniFi Access. Returns: event, description. Some events require UniFi Access version 3.3.10 or later.
- **List all UniFi On Prem webhooks** (List). List webhook endpoints configured in UniFi Access. Returns: id, endpoint, name, events, secret, headers.
- **Create a UniFi On Prem webhook** (Create). Create a webhook endpoint in UniFi Access to receive event notifications. Returns: id, endpoint, name, events, secret, headers. Required: name, endpoint, events.
- **Update a UniFi On Prem webhook by ID** (Update). Update an existing webhook endpoint in UniFi Access by id. Returns: id, endpoint, name, events, secret, headers. Required: id, name, endpoint, events.
- **Delete a UniFi On Prem webhook by ID** (Delete). Delete a webhook endpoint in UniFi Access by id. Returns an empty 204 response on success. Required: id.
- **UniFi On Prem webhooks allow owner** (Action). Allow a webhook endpoint owner to receive webhook events in UniFi Access. Returns a success confirmation string. Required: endpoint_id.
- **UniFi On Prem API server upload certificate** (Upload). Upload an HTTPS certificate to the UniFi Access API server on port 12445 in unifionprem. Returns the string 'success' on completion. Required: key, cert. Restarting the Access application is necessary to apply the changes.
- **UniFi On Prem API server delete certificate** (Delete). Delete the HTTPS certificate from the UniFi Access API server on port 12445 in unifionprem. Returns the string 'success' on completion. Restarting the Access application is necessary to apply the changes.
- **List all UniFi On Prem group users** (List). List users directly assigned to a user group in UniFi Access, excluding users in any subgroups. Returns: id, first_name, last_name, full_name, alias, email, email_status, employee_number, phone, onboard_time, status, user_email, username, avatar_relative_path. Required: user_group_id.