Skip to content

granular_permissions.md

Latest commit

 

History

History
203 lines (139 loc) · 7.37 KB

granular_permissions.md

File metadata and controls

203 lines (139 loc) · 7.37 KB

Base Permissions required for the Integration

OPNsense Permission API Endpoints
Lobby: Dashboard /api/diagnostics/system/system_information (or systemInformation)
Status: Interfaces /api/interfaces/overview/export
System: Firmware /api/core/firmware/status

Granular Sync Permissions

Basic telemetry data

OPNsense Permission API Endpoints
Lobby: Dashboard /api/diagnostics/system/system_mbuf
/api/diagnostics/firewall/pf_states
/api/diagnostics/system/system_resources (or systemResources)
/api/diagnostics/system/system_swap
/api/diagnostics/system/system_time (or systemTime)
/api/diagnostics/cpu_usage/get_c_p_u_type (or getCPUType)
/api/diagnostics/cpu_usage/stream
/api/diagnostics/system/system_disk (or systemDisk)
/api/diagnostics/system/system_temperature (or systemTemperature)

Gateway information

OPNsense Permission API Endpoints
System: Gateways /api/routes/gateway/status

Interface information

OPNsense Permission API Endpoints
Status: Interfaces /api/interfaces/overview/export

DHCP leases

OPNsense Permission API Endpoints
Services: DHCP: Kea(v4) /api/kea/leases4/search
/api/kea/dhcpv4/search_reservation (or searchReservation)
/api/kea/dhcpv4/get
Status: DHCP leases /api/dhcpv4/leases/search_lease (or searchLease)
Status: DHCPv6 leases /api/dhcpv6/leases/search_lease (or searchLease)
Services: Dnsmasq DNS/DHCP: Settings /api/dnsmasq/leases/search

Notice information

OPNsense Permission API Endpoints
System: Status /api/core/system/status

Firmware updates

OPNsense Permission API Endpoints
System: Firmware /api/core/firmware/changelog
/api/core/firmware/status
/api/core/firmware/update
/api/core/firmware/upgrade
/api/core/firmware/upgradestatus

CARP information

OPNsense Permission API Endpoints
Interfaces: Virtual IPs: Status /api/diagnostics/interface/get_vip_status
Interfaces: Virtual IPs: Settings /api/interfaces/vip_settings/get

Firewall rules and NAT rules switches

OPNsense Firmware 26.1.1+

OPNsense Permission API Endpoints
Firewall: Rules [New] /api/firewall/filter/search_rule
/api/firewall/filter/toggle_rule
Firewall: NAT: Destination NAT /api/firewall/d_nat/search_rule
/api/firewall/d_nat/toggle_rule
Firewall: NAT: 1:1 /api/firewall/one_to_one/search_rule
/api/firewall/one_to_one/toggle_rule
Firewall: NAT: Source NAT /api/firewall/source_nat/search_rule
/api/firewall/source_nat/toggle_rule
Firewall: NAT: NPTv6 /api/firewall/npt/search_rule
/api/firewall/npt/toggle_rule

OPNsense Firmware < 26.1.1

**OPNsense plugin required**

OPNsense Permission API Endpoints
XMLRPC Library N/A – Operations are executed using the XMLRPC interface and OPNsense plugin

Service switches

OPNsense Permission API Endpoints
Status: Services /api/core/service/search
/api/core/service/start
/api/core/service/stop

VPN information and switches

OPNsense Permission API Endpoints
Status: OpenVPN /api/openvpn/service/reconfigure
/api/openvpn/service/search_sessions (or searchSessions)
VPN: OpenVPN: Instances /api/openvpn/instances/get
/api/openvpn/instances/search
/api/openvpn/instances/toggle
VPN: OpenVPN: Client Export Utility /api/openvpn/export/providers
VPN: WireGuard /api/wireguard/client/get
/api/wireguard/client/toggle_client (or toggleClient)
/api/wireguard/server/get
/api/wireguard/service/reconfigure
/api/wireguard/service/show
/api/wireguard/server/toggle_server (or toggleServer)

Security certificate information

OPNsense Permission API Endpoints
System: Certificate Manager /api/trust/cert/search

Unbound blocklist switch

OPNsense Permission API Endpoints
Services: Unbound (MVC) Firmware <25.7.8
/api/unbound/service/dnsbl
/api/unbound/settings/get
/api/unbound/service/restart
/api/unbound/settings/set
Firmware >=25.7.8
/api/unbound/settings/search_dnsbl
/api/unbound/settings/toggle_dnsbl

Device Trackers

OPNsense Permission API Endpoints
Diagnostics: ARP Table /api/diagnostics/interface/search_arp

Speedtest results

OPNsense Permission API Endpoints
Monitoring: Speedtest /api/speedtest/service/showrecent
/api/speedtest/service/showstat

vnStat metrics

OPNsense Permission API Endpoints
Services: Vnstat /api/vnstat/service/hourly
/api/vnstat/service/daily
/api/vnstat/service/monthly

Action (Service) Permissions

Close Notice (opnsense.close_notice)

OPNsense Permission API Endpoints
System: Status /api/core/system/dismiss_status (or dismissStatus)
/api/core/system/status

Shutdown OPNsense (opnsense.system_halt)

OPNsense Permission API Endpoints
Diagnostics: Halt system /api/core/system/halt

Reboot OPNsense (opnsense.system_reboot)

OPNsense Permission API Endpoints
Diagnostics: Reboot System /api/core/system/reboot

Start Service (opnsense.start_service)

OPNsense Permission API Endpoints
Status: Services /api/core/service/start

Stop Service (opnsense.stop_service)

OPNsense Permission API Endpoints
Status: Services /api/core/service/stop

Restart Service (opnsense.restart_service)

OPNsense Permission API Endpoints
Status: Services /api/core/service/restart

Send Wake on LAN (opnsense.send_wol)

OPNsense Permission API Endpoints
Services: Wake on LAN /api/wol/wol/set

Reload Interface (opnsense.reload_interface)

OPNsense Permission API Endpoints
Status: Interfaces /api/interfaces/overview/reload_interface (or reloadInterface)

Kill States (opnsense.kill_states)

OPNsense Permission API Endpoints
Diagnostics: Show States /api/diagnostics/firewall/kill_states

Generate Captive Portal Vouchers (opnsense.generate_vouchers)

OPNsense Permission API Endpoints
Services: Captive Portal /api/captiveportal/voucher/generate_vouchers (or generateVouchers)
/api/captiveportal/voucher/list_providers (or listProviders)

Toggle Alias (opnsense.toggle_alias)

OPNsense Permission API Endpoints
Firewall: Alias: Edit /api/firewall/alias/reconfigure
/api/firewall/alias/search_item (or searchItem)
/api/firewall/alias/set
/api/firewall/alias/toggle_item (or toggleItem)

Run Speedtest (opnsense.run_speedtest)

OPNsense Permission API Endpoints
Monitoring: Speedtest /api/speedtest/service/run

Get vnStat Metrics (opnsense.get_vnstat_metrics)

OPNsense Permission API Endpoints
Services: Vnstat /api/vnstat/service/hourly
/api/vnstat/service/daily
/api/vnstat/service/monthly
/api/vnstat/service/yearly