access-control-tool
Execute Rhombus access control tasks: unlock doors, list groups, get credentials, activate/deactivate lockdowns, retrieve door schedules and access grants.
Instructions
This tool manages Rhombus access control operations including door unlocking, access groups, credentials, lockdown plans, door schedules, and access grants.
It has the following modes of operation, determined by the "requestType" parameter:
unlock-door: Remotely unlock an access controlled door. Requires doorUuid.
get-groups: List all access control groups in the organization.
get-credentials-by-user: List all access control credentials for a specific user. Requires userUuid.
get-lockdown-plans: List all lockdown plans in the organization.
activate-lockdown: Activate a lockdown plan at a location. Requires locationUuid and lockdownPlanUuid.
deactivate-lockdown: Deactivate a lockdown plan at a location. Requires locationUuid and lockdownPlanUuid.
get-door-schedules: Get door schedule exceptions for a location. Requires locationUuid.
get-access-grants: List location access grants (physical badge/card access). Optionally accepts locationUuid to filter by location. Each grant includes userUuids (directly assigned users), groupUuids (assigned access control groups), and doorUuids (the doors this grant provides access to).
get-remote-unlock-users: Get all users who have permission to remotely unlock doors at a location. Requires locationUuid. Returns a list of doors with remote unlock enabled and the users who can unlock each door, based on their permission group roles. This is the correct tool for questions about remote unlock permissions.
Use the get-entity-tool with entityType ACCESS_CONTROL_DOOR to get door UUIDs. Use the user-tool to look up user UUIDs and resolve them to names/emails. Use the location-tool to get location UUIDs.
Output filtering (all tools):
includeFields(string[]): Dot-notation paths to keep in the response (e.g."vehicleEvents.vehicleLicensePlate"). Omit to return all fields.filterBy(array): Predicates to filter array items. Each entry:{field, op, value}where op is one of= != > >= < <= contains. All conditions are ANDed. Example:[{field:"vehicleLicensePlate", op:"=", value:"ABC123"}]WARNING: some tool responses exceed 400k characters — use these params to request only the data you need.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| requestType | Yes | The type of access control request to make. | |
| doorUuid | Yes | The UUID of the access controlled door. Required for 'unlock-door'. | |
| userUuid | Yes | The UUID of the user. Required for 'get-credentials-by-user'. | |
| locationUuid | Yes | The UUID of the location. Required for 'activate-lockdown', 'deactivate-lockdown', 'get-door-schedules', and 'get-remote-unlock-users'. Optional for 'get-access-grants' to filter by location. | |
| lockdownPlanUuid | Yes | The UUID of the lockdown plan. Required for 'activate-lockdown' and 'deactivate-lockdown'. | |
| includeFields | Yes | Dot-notation field paths to include in the response (e.g. "vehicleEvents.vehicleLicensePlate"). Pass null to return all fields. WARNING: some responses can exceed 400k characters — use includeFields to request only the data you need. For high-volume tools this may be required to get a complete answer. | |
| filterBy | Yes | Filter array items in the response by field values. All conditions are ANDed. Example: [{field: "vehicleLicensePlate", op: "=", value: "ABC123"}, {field: "confidence", op: ">", value: 0.8}] Use alongside includeFields to get only the specific records and fields you need. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| unlockResult | No | Result of unlocking a door | |
| accessControlGroups | No | List of access control groups | |
| credentials | No | List of access control credentials for a user | |
| lockdownPlans | No | List of lockdown plans | |
| lockdownResult | No | Result of activating or deactivating a lockdown | |
| doorScheduleExceptions | No | Door schedule exceptions | |
| accessGrants | No | List of location access grants. Each grant contains userUuids and groupUuids that have access to the doorUuids in the grant. | |
| remoteUnlockUsers | No | Users who can remotely unlock doors at a location, grouped by permission group. Always present the COMPLETE list of all users to the end user. | |
| error | No | An error message if the request failed. |