.. This code is auto generated, do NOT alter it directly .. _user/ui-access: ######### UI Access ######### ***** Pages ***** Below you can find the list of pages available on the Admin-UI along side the optional and required permissions to access them. ==== Data ==== .. _ui__data_explorer: ------------- Data Explorer ------------- ``/data/explorer`` **Required permissions** * :ref:`ui_ENDPOINT_STATE_READ` * :ref:`ui_MAPPING_STATE_READ` * :ref:`ui_NODE_STATE_READ` * :ref:`ui_TOPICS_SUBSCRIPTION` * :ref:`ui_TOPICS_SUBSCRIPTION_METADATA` ======== Services ======== .. _ui__services_rule_engine_sandbox: ------------ Rule Sandbox ------------ ``/services/rule-engine-sandbox`` **Required permissions** * :ref:`ui_RULE_ENGINE_SANDBOX_USE` * :ref:`ui_TOPICS_SUBSCRIPTION` .. _ui__services_catalog: --------------- Service Catalog --------------- ``/services/catalog`` **Required permissions** * :ref:`ui_SERVICES_CATALOG_READ` * :ref:`ui_SERVICES_CREATE_OR_UPDATE` .. _ui__services_logs: ------------ Service Logs ------------ ``/services/logs`` **Required permissions** * :ref:`ui_LOGS_READ` .. _ui__services_overview: ---------------- Service Overview ---------------- ``/services/overview`` **Required permissions** * :ref:`ui_SERVICES_READ` **Optional permissions** * :ref:`ui_SERVICES_CREATE_OR_UPDATE` * :ref:`ui_SERVICES_MANAGE` * :ref:`ui_SERVICE_READ` .. _ui__services_edit_template: ^^^^^^^^^^^^^ Edit template ^^^^^^^^^^^^^ ``/services/edit-template`` **Required permissions** * :ref:`ui_SERVICE_TEMPLATE_EDIT` .. _ui__services_overview_serviceId: ^^^^^^^^^^^^^^^ Service Details ^^^^^^^^^^^^^^^ ``/services/overview/:serviceId`` **Required permissions** * :ref:`ui_SERVICE_READ` **Optional permissions** * :ref:`ui_CONNECTIONS_READ` * :ref:`ui_ENDPOINTS_READ` * :ref:`ui_LOGS_READ` * :ref:`ui_MAPPINGS_READ` * :ref:`ui_SERVERS_READ` * :ref:`ui_SERVICES_CREATE_OR_UPDATE` * :ref:`ui_SERVICES_MANAGE` * :ref:`ui_SERVICE_CONTAINERS_READ` * :ref:`ui_VOLUMES_READ` .. _ui__services_overview_serviceId_connections_resourceId: """""""""" Connection """""""""" ``/services/overview/:serviceId/connections/:resourceId`` **Required permissions** * :ref:`ui_CONNECTION_READ` **Optional permissions** * :ref:`ui_CONNECTIONS_MANAGE` * :ref:`ui_LOGS_READ` .. _ui__services_overview_serviceId_containers_resourceId: """"""""" Container """"""""" ``/services/overview/:serviceId/containers/:resourceId`` **Required permissions** * :ref:`ui_SERVICE_CONTAINER_READ` **Optional permissions** * :ref:`ui_LOGS_READ` * :ref:`ui_SERVICE_CONTAINERS_MANAGE` .. _ui__services_overview_serviceId_endpoints_resourceId: """""""" Endpoint """""""" ``/services/overview/:serviceId/endpoints/:resourceId`` **Required permissions** * :ref:`ui_ENDPOINT_READ` **Optional permissions** * :ref:`ui_ENDPOINTS_MANAGE` * :ref:`ui_LOGS_READ` .. _ui__services_overview_serviceId_mappings_resourceId: """"""" Mapping """"""" ``/services/overview/:serviceId/mappings/:resourceId`` **Required permissions** * :ref:`ui_MAPPING_READ` **Optional permissions** * :ref:`ui_LOGS_READ` * :ref:`ui_MAPPINGS_MANAGE` * :ref:`ui_TOPICS_SUBSCRIPTION` .. _ui__services_overview_serviceId_servers_resourceId: """""" Server """""" ``/services/overview/:serviceId/servers/:resourceId`` **Required permissions** * :ref:`ui_SERVER_READ` **Optional permissions** * :ref:`ui_LOGS_READ` * :ref:`ui_NODES_READ` * :ref:`ui_SERVERS_MANAGE` .. _ui__services_overview_serviceId_volumes_resourceId: """""" Volume """""" ``/services/overview/:serviceId/volumes/:resourceId`` **Required permissions** * :ref:`ui_VOLUME_READ` **Optional permissions** * :ref:`ui_LOGS_READ` * :ref:`ui_VOLUMES_MANAGE` .. _ui__services_resources: ----------------- Service Resources ----------------- ``/services/resources`` **Required permissions** Fulfil any of the required permissions below and **Service Resources** will be available * :ref:`ui_CONNECTIONS_READ` * :ref:`ui_ENDPOINTS_READ` * :ref:`ui_MAPPINGS_READ` * :ref:`ui_SERVERS_READ` * :ref:`ui_SERVICES_READ` * :ref:`ui_SERVICE_CONTAINERS_READ` * :ref:`ui_VOLUMES_READ` **Optional permissions** * :ref:`ui_CONNECTIONS_MANAGE` * :ref:`ui_CONNECTION_READ` * :ref:`ui_ENDPOINTS_MANAGE` * :ref:`ui_ENDPOINT_READ` * :ref:`ui_MAPPINGS_MANAGE` * :ref:`ui_MAPPING_READ` * :ref:`ui_SERVERS_MANAGE` * :ref:`ui_SERVER_READ` * :ref:`ui_SERVICE_CONTAINERS_MANAGE` * :ref:`ui_SERVICE_CONTAINER_READ` * :ref:`ui_SERVICE_READ` * :ref:`ui_VOLUMES_MANAGE` * :ref:`ui_VOLUME_READ` .. _ui__services_resources_connections: ^^^^^^^^^^^ Connections ^^^^^^^^^^^ ``/services/resources/connections`` **Required permissions** * :ref:`ui_CONNECTIONS_READ` **Optional permissions** * :ref:`ui_CONNECTIONS_MANAGE` * :ref:`ui_CONNECTION_READ` .. _ui__services_resources_connections_resourceId: """""""""" Connection """""""""" ``/services/resources/connections/:resourceId`` **Required permissions** * :ref:`ui_CONNECTION_READ` **Optional permissions** * :ref:`ui_CONNECTIONS_MANAGE` * :ref:`ui_LOGS_READ` .. _ui__services_resources_containers: ^^^^^^^^^^ Containers ^^^^^^^^^^ ``/services/resources/containers`` **Required permissions** * :ref:`ui_SERVICE_CONTAINERS_READ` **Optional permissions** * :ref:`ui_SERVICE_CONTAINERS_MANAGE` * :ref:`ui_SERVICE_CONTAINER_READ` .. _ui__services_resources_containers_resourceId: """"""""" Container """"""""" ``/services/resources/containers/:resourceId`` **Required permissions** * :ref:`ui_SERVICE_CONTAINER_READ` **Optional permissions** * :ref:`ui_LOGS_READ` * :ref:`ui_SERVICE_CONTAINERS_MANAGE` .. _ui__services_resources_endpoints: ^^^^^^^^^ Endpoints ^^^^^^^^^ ``/services/resources/endpoints`` **Required permissions** * :ref:`ui_ENDPOINTS_READ` **Optional permissions** * :ref:`ui_ENDPOINTS_MANAGE` * :ref:`ui_ENDPOINT_READ` .. _ui__services_resources_endpoints_resourceId: """""""" Endpoint """""""" ``/services/resources/endpoints/:resourceId`` **Required permissions** * :ref:`ui_ENDPOINT_READ` **Optional permissions** * :ref:`ui_ENDPOINTS_MANAGE` * :ref:`ui_LOGS_READ` .. _ui__services_resources_mappings: ^^^^^^^^ Mappings ^^^^^^^^ ``/services/resources/mappings`` **Required permissions** * :ref:`ui_MAPPINGS_READ` **Optional permissions** * :ref:`ui_MAPPINGS_MANAGE` * :ref:`ui_MAPPING_READ` .. _ui__services_resources_mappings_resourceId: """"""" Mapping """"""" ``/services/resources/mappings/:resourceId`` **Required permissions** * :ref:`ui_MAPPING_READ` **Optional permissions** * :ref:`ui_LOGS_READ` * :ref:`ui_MAPPINGS_MANAGE` * :ref:`ui_TOPICS_SUBSCRIPTION` .. _ui__services_resources_servers: ^^^^^^^ Servers ^^^^^^^ ``/services/resources/servers`` **Required permissions** * :ref:`ui_SERVERS_READ` **Optional permissions** * :ref:`ui_SERVERS_MANAGE` * :ref:`ui_SERVER_READ` .. _ui__services_resources_servers_resourceId: """""" Server """""" ``/services/resources/servers/:resourceId`` **Required permissions** * :ref:`ui_SERVER_READ` **Optional permissions** * :ref:`ui_LOGS_READ` * :ref:`ui_NODES_READ` * :ref:`ui_SERVERS_MANAGE` .. _ui__services_resources_links: ^^^^^^^^^^^^^ Service Links ^^^^^^^^^^^^^ ``/services/resources/links`` **Required permissions** * :ref:`ui_SERVICES_READ` **Optional permissions** * :ref:`ui_SERVICE_READ` .. _ui__services_resources_service_resourceId: """"""""""""""" Service Details """"""""""""""" ``/services/resources/service/:resourceId`` **Required permissions** * :ref:`ui_SERVICE_READ` **Optional permissions** * :ref:`ui_CONNECTIONS_READ` * :ref:`ui_ENDPOINTS_READ` * :ref:`ui_LOGS_READ` * :ref:`ui_MAPPINGS_READ` * :ref:`ui_SERVERS_READ` * :ref:`ui_SERVICES_CREATE_OR_UPDATE` * :ref:`ui_SERVICES_MANAGE` * :ref:`ui_SERVICE_CONTAINERS_READ` * :ref:`ui_VOLUMES_READ` .. _ui__services_resources_volumes: ^^^^^^^ Volumes ^^^^^^^ ``/services/resources/volumes`` **Required permissions** * :ref:`ui_VOLUMES_READ` **Optional permissions** * :ref:`ui_VOLUMES_MANAGE` * :ref:`ui_VOLUME_READ` .. _ui__services_resources_volumes_resourceId: """""" Volume """""" ``/services/resources/volumes/:resourceId`` **Required permissions** * :ref:`ui_VOLUME_READ` **Optional permissions** * :ref:`ui_LOGS_READ` * :ref:`ui_VOLUMES_MANAGE` ======== Settings ======== .. _ui__settings_login: ----- Login ----- ``/settings/login`` **Optional permissions** * :ref:`ui_MINIMUM` * :ref:`ui_USE_MFA` ====== System ====== .. _ui__system_backup_and_restore: ---------------- Backup & Restore ---------------- ``/system/backup-and-restore`` **Required permissions** * :ref:`ui_SYSTEM_BACKUP_MANAGE` .. _ui__system_status: ------------- System Status ------------- ``/system/status`` **Required permissions** Fulfil any of the required permissions below and **System Status** will be available * :ref:`ui_AGENTS_READ` * :ref:`ui_CORE_CONTAINERS_READ` * :ref:`ui_MINIMUM` * :ref:`ui_MINIMUM` * :ref:`ui_MINIMUM` * :ref:`ui_SYSTEM_METRICS_READ` **Optional permissions** * :ref:`ui_AGENTS_MANAGE` * :ref:`ui_CORE_CONTAINERS_MANAGE` * :ref:`ui_CORE_CONTAINER_READ` * :ref:`ui_SERVICES_READ` * :ref:`ui_SYSTEM_LICENSE_MANAGE` * :ref:`ui_SYSTEM_METRICS_MANAGE` .. _ui__system_status_agents: ^^^^^^ Agents ^^^^^^ ``/system/status/agents`` **Required permissions** * :ref:`ui_AGENTS_READ` **Optional permissions** * :ref:`ui_AGENTS_MANAGE` .. _ui__system_status_internet_connectivity: ^^^^^^^^^^^^^^^^^^^^^ Internet Connectivity ^^^^^^^^^^^^^^^^^^^^^ ``/system/status/internet-connectivity`` **Required permissions** * :ref:`ui_MINIMUM` .. _ui__system_status_license: ^^^^^^^ License ^^^^^^^ ``/system/status/license`` **Required permissions** * :ref:`ui_MINIMUM` **Optional permissions** * :ref:`ui_SYSTEM_LICENSE_MANAGE` .. _ui__system_status_metrics: ^^^^^^^ Metrics ^^^^^^^ ``/system/status/metrics`` **Required permissions** * :ref:`ui_SYSTEM_METRICS_READ` **Optional permissions** * :ref:`ui_SYSTEM_METRICS_MANAGE` .. _ui__system_status_container: ^^^^^^^^^^^^^^^^ System Container ^^^^^^^^^^^^^^^^ ``/system/status/container`` **Required permissions** * :ref:`ui_CORE_CONTAINERS_READ` **Optional permissions** * :ref:`ui_CORE_CONTAINERS_MANAGE` * :ref:`ui_CORE_CONTAINER_READ` .. _ui__system_status_container_resourceId: """"""""" Container """"""""" ``/system/status/container/:resourceId`` **Required permissions** * :ref:`ui_CORE_CONTAINER_READ` **Optional permissions** * :ref:`ui_CORE_CONTAINERS_MANAGE` * :ref:`ui_LOGS_READ` .. _ui__system_status_information: ^^^^^^^^^^^^^^^^^^ System Information ^^^^^^^^^^^^^^^^^^ ``/system/status/information`` **Required permissions** * :ref:`ui_MINIMUM` **Optional permissions** * :ref:`ui_SERVICES_READ` ==== User ==== .. _ui__user_client_registry: --------------- Client Registry --------------- ``/user/client-registry`` **Required permissions** * :ref:`ui_CLIENT_REGISTRY_MANAGE` .. _ui__user_certificates: ----------------- User Certificates ----------------- ``/user/certificates`` **Required permissions** * :ref:`ui_CERTIFICATES_MANAGE` .. _ui__user_management: --------------- User Management --------------- ``/user/management`` **Required permissions** * :ref:`ui_MANAGE_PERMISSIONS` * :ref:`ui_MANAGE_ROLES` * :ref:`ui_MANAGE_USERS` *********** Permissions *********** Below you can find the alternative permissions that can be assigned to users and roles in order to enable them to perform actions on the Admin UI. .. _ui_SERVICES_CREATE_OR_UPDATE: ============================= Creating or updating services ============================= .. list-table:: * - Resource - Context - Operation * - ``/api/services/+`` - ``http`` - ``write`` * - ``/api/services`` - ``http`` - ``write`` .. _ui_DEVIATIONS_READ: ==================== Detecting deviations ==================== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/services/+`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_SERVICE_TEMPLATE_EDIT: ====================== Edit service templates ====================== .. list-table:: * - Resource - Context - Operation * - ``/api/resources/schemas`` - ``http`` - ``read`` * - ``/api/validate/service`` - ``http`` - ``write`` .. _ui_AGENTS_READ: ============== Loading agents ============== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/system/agents`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_CONNECTION_READ: ============================ Loading connection's details ============================ By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/connections/+`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_CONNECTIONS_READ: =================== Loading connections =================== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/connections`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_SYSTEM_METRICS_READ: ============================= Loading Connectware's metrics ============================= .. list-table:: * - Resource - Context - Operation * - ``/api/system/metrics`` - ``http`` - ``read`` * - ``/api/system/preflight`` - ``http`` - ``read`` .. _ui_MINIMUM: ======================================== Loading Connectware's system information ======================================== .. list-table:: * - Resource - Context - Operation * - ``/api/permissions`` - ``http`` - ``read`` * - ``/api/system/info`` - ``http`` - ``read`` * - ``/api/system/preflight`` - ``http`` - ``read`` * - ``/api/users/change-password`` - ``http`` - ``write`` .. _ui_TOPICS_SUBSCRIPTION_METADATA: ===================================== Loading Connectware's topics metadata ===================================== .. list-table:: * - Resource - Context - Operation * - ``/api/topics`` - ``http`` - ``read`` .. _ui_CORE_CONTAINER_READ: ================================ Loading core container's details ================================ By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/core-containers/+/inspect`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_CORE_CONTAINERS_READ: ======================= Loading core containers ======================= By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/core-containers/+/inspect`` - ``http`` - ``read`` * - ``/api/core-containers/orchestrator`` - ``http`` - ``read`` * - ``/api/core-containers`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_ENDPOINT_STATE_READ: ======================== Loading endpoint's state ======================== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/endpoints/+/state`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_ENDPOINTS_READ: ================= Loading endpoints ================= By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/endpoints`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_ENDPOINT_READ: ========================= Loading endpont's details ========================= By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/endpoints/+/topics`` - ``http`` - ``read`` * - ``/api/endpoints/+`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_LOGS_READ: ============ Loading logs ============ .. list-table:: * - Resource - Context - Operation * - ``/api/core-containers/+/logs`` - ``http`` - ``read`` * - ``/api/core-containers/orchestrator`` - ``http`` - ``read`` * - ``/api/core-containers`` - ``http`` - ``read`` * - ``/api/system/agents`` - ``http`` - ``read`` .. _ui_MAPPING_READ: ========================= Loading mapping's details ========================= By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/mappings/+/endpoint-topics`` - ``http`` - ``read`` * - ``/api/mappings/+`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_MAPPING_STATE_READ: ======================= Loading mapping's state ======================= By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/mappings/+/state`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_MAPPINGS_READ: ================ Loading mappings ================ By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/mappings`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_NODE_STATE_READ: ==================== Loading node's state ==================== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/nodes/+/state`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_NODES_READ: ============= Loading nodes ============= By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/nodes`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_SERVER_READ: ======================== Loading server's details ======================== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/servers/+`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_SERVERS_READ: =============== Loading servers =============== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/servers`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_SERVICE_CONTAINER_READ: =================================== Loading service container's details =================================== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/containers/+/inspect`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_SERVICE_CONTAINERS_READ: ========================== Loading service containers ========================== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/containers/+/inspect`` - ``http`` - ``read`` * - ``/api/containers/orchestrator`` - ``http`` - ``read`` * - ``/api/containers`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_SERVICES_CATALOG_READ: ================================== Loading service's catalog metadata ================================== .. list-table:: * - Resource - Context - Operation * - ``/api/marketplace/app/meta`` - ``http`` - ``read`` * - ``/api/marketplace/app`` - ``http`` - ``read`` * - ``/api/marketplace/apps`` - ``http`` - ``read`` .. _ui_SERVICE_READ: ========================= Loading service's details ========================= By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/services/+/dependencies`` - ``http`` - ``read`` * - ``/api/services/+`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_SERVICES_READ: ================ Loading services ================ By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/services/+`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_VOLUME_READ: ======================== Loading volume's details ======================== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/volumes/+/inspect`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_VOLUMES_READ: =============== Loading volumes =============== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/volumes`` - ``http`` - ``read`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_AGENTS_MANAGE: =============== Managing agents =============== .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_CERTIFICATES_MANAGE: ===================== Managing certificates ===================== .. list-table:: * - Resource - Context - Operation * - ``/api/certificates/+`` - ``http`` - ``read`` * - ``/api/certificates`` - ``http`` - ``readWrite`` .. _ui_CONNECTIONS_MANAGE: ==================== Managing connections ==================== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/connections/+/operation`` - ``http`` - ``write`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_SYSTEM_BACKUP_MANAGE: ============================== Managing Connectware's backups ============================== .. list-table:: * - Resource - Context - Operation * - ``/api/maintenance/db/+`` - ``http`` - ``readWrite`` * - ``/api/maintenance/db`` - ``http`` - ``read`` .. _ui_SYSTEM_LICENSE_MANAGE: ============================== Managing Connectware's license ============================== .. list-table:: * - Resource - Context - Operation * - ``/api/system/licensefile`` - ``http`` - ``write`` * - ``/api/system/refresh`` - ``http`` - ``read`` .. _ui_SYSTEM_METRICS_MANAGE: ============================== Managing Connectware's metrics ============================== .. list-table:: * - Resource - Context - Operation * - ``/api/system/metrics`` - ``http`` - ``write`` .. _ui_CORE_CONTAINERS_MANAGE: ======================== Managing core containers ======================== .. list-table:: * - Resource - Context - Operation * - ``/api/core-containers/+/operation`` - ``http`` - ``write`` .. _ui_ENDPOINTS_MANAGE: ================== Managing endpoints ================== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/endpoints/+/operation`` - ``http`` - ``write`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_MAPPINGS_MANAGE: ================= Managing mappings ================= By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/mappings/+/operation`` - ``http`` - ``write`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_MANAGE_PERMISSIONS: ==================== Managing permissions ==================== .. list-table:: * - Resource - Context - Operation * - ``/api/permissions/#`` - ``http`` - ``read`` .. _ui_MANAGE_ROLES: ============== Managing roles ============== .. list-table:: * - Resource - Context - Operation * - ``/api/roles/#`` - ``http`` - ``readWrite`` * - ``/api/roles`` - ``http`` - ``write`` .. _ui_SERVERS_MANAGE: ================ Managing servers ================ By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/servers/+/operation`` - ``http`` - ``write`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_SERVICE_CONTAINERS_MANAGE: =========================== Managing service containers =========================== By using HTTP .. list-table:: * - Resource - Context - Operation * - ``/api/containers/+/operation`` - ``http`` - ``write`` Or through MQTT .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_SERVICES_MANAGE: ================= Managing services ================= .. list-table:: * - Resource - Context - Operation * - ``/api/services/+/operation`` - ``http`` - ``write`` * - ``/api/services/+`` - ``http`` - ``write`` .. _ui_CLIENT_REGISTRY_MANAGE: ============================ Managing the client registry ============================ .. list-table:: * - Resource - Context - Operation * - ``/api/client-registry/+`` - ``http`` - ``readWrite`` * - ``/api/client-registry`` - ``http`` - ``read`` .. _ui_MANAGE_USERS: ============== Managing users ============== .. list-table:: * - Resource - Context - Operation * - ``/api/auth/ldap`` - ``http`` - ``read`` * - ``/api/listUsers`` - ``http`` - ``read`` * - ``/api/policy/password`` - ``http`` - ``read`` * - ``/api/users/#`` - ``http`` - ``readWrite`` .. _ui_VOLUMES_MANAGE: ================ Managing volumes ================ .. list-table:: * - Resource - Context - Operation * - ``#`` - ``mqtt`` - ``readWrite`` .. _ui_TOPICS_SUBSCRIPTION: ========================== Subscribing to MQTT Topics ========================== .. list-table:: * - Resource - Context - Operation * - Any - ``mqtt`` - ``read`` .. _ui_USE_MFA: =============================== Use Multi-factor authentication =============================== .. list-table:: * - Resource - Context - Operation * - ``/api/mfa/disable`` - ``http`` - ``write`` * - ``/api/mfa/enable`` - ``http`` - ``write`` * - ``/api/mfa/isenrolled`` - ``http`` - ``read`` * - ``/api/mfa/login`` - ``http`` - ``write`` * - ``/api/mfa/regenerate/backupcodes`` - ``http`` - ``write`` * - ``/api/mfa/validate`` - ``http`` - ``write`` .. _ui_RULE_ENGINE_SANDBOX_USE: ===================== Using the Rule Engine ===================== .. list-table:: * - Resource - Context - Operation * - ``/api/endpoints`` - ``http`` - ``read`` * - ``/api/rule-engine/+`` - ``http`` - ``write`` .. _ui_WORKBENCH: =================== Using the workbench =================== .. list-table:: * - Resource - Context - Operation * - ``/workbench/#`` - ``http`` - ``readWrite`` * - ``/workbench`` - ``http`` - ``readWrite``