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
Data Explorer
/data/explorer
Required permissions
Optional permissions
Services
Deviated Services
/services/deviated
Required permissions
Optional permissions
Rule Sandbox
/services/rule-engine-sandbox
Required permissions
Optional permissions
Service Catalog
/services/catalog
Required permissions
Service Logs
/services/logs
Required permissions
Service Overview
/services/overview
Required permissions
Optional permissions
Edit template
/services/edit-template
Required permissions
Service Details
/services/overview/:serviceId
Required permissions
Optional permissions
In order to create and update services the following permissions are required:
In order to use service`s Live Data the following permissions are required:
Connection
/services/overview/:serviceId/connections/:resourceId
Required permissions
Optional permissions
Container
/services/overview/:serviceId/containers/:resourceId
Required permissions
Optional permissions
Endpoint
/services/overview/:serviceId/endpoints/:resourceId
Required permissions
Optional permissions
Mapping
/services/overview/:serviceId/mappings/:resourceId
Required permissions
Optional permissions
Server
/services/overview/:serviceId/servers/:resourceId
Required permissions
Optional permissions
Volume
/services/overview/:serviceId/volumes/:resourceId
Required permissions
Optional permissions
Service Resources
/services/resources
Required permissions
Fulfil any of the required permissions below and Service Resources will be available
Optional permissions
Connections
/services/resources/connections
Required permissions
Optional permissions
Connection
/services/resources/connections/:resourceId
Required permissions
Optional permissions
Containers
/services/resources/containers
Required permissions
Optional permissions
Container
/services/resources/containers/:resourceId
Required permissions
Optional permissions
Endpoints
/services/resources/endpoints
Required permissions
Optional permissions
Endpoint
/services/resources/endpoints/:resourceId
Required permissions
Optional permissions
Mappings
/services/resources/mappings
Required permissions
Optional permissions
Mapping
/services/resources/mappings/:resourceId
Required permissions
Optional permissions
Servers
/services/resources/servers
Required permissions
Optional permissions
Server
/services/resources/servers/:resourceId
Required permissions
Optional permissions
Service Links
/services/resources/links
Required permissions
Optional permissions
Service Details
/services/resources/service/:resourceId
Required permissions
Optional permissions
In order to create and update services the following permissions are required:
In order to use service`s Live Data the following permissions are required:
Volumes
/services/resources/volumes
Required permissions
Optional permissions
Volume
/services/resources/volumes/:resourceId
Required permissions
Optional permissions
Settings
Login
/settings/login
Optional permissions
In order to manage your password the following permissions are required:
System
Backup & Restore
/system/backup-and-restore
Required permissions
System Status
/system/status
Required permissions
Fulfil any of the required permissions below and System Status will be available
Optional permissions
Agents
/system/status/agents
Required permissions
Optional permissions
Internet Connectivity
/system/status/internet-connectivity
Required permissions
License
/system/status/license
Required permissions
Optional permissions
Metrics
/system/status/metrics
Required permissions
Optional permissions
System Container
/system/status/container
Required permissions
Optional permissions
Container
/system/status/container/:resourceId
Required permissions
Optional permissions
System Information
/system/status/information
Required permissions
Optional permissions
User
Client Registry
/user/client-registry
Required permissions
User Certificates
/user/certificates
Required permissions
User Management
Permissions
/user/management/permissions
Required permissions
Roles
/user/management/roles
Required permissions
Users
/user/management/users
Required permissions
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.
Creating or updating services
/api/services/parametersSchema
http
write
/api/services
http
write
/api/v2/services/+
http
write
Detecting and listing deviations
/api/v2/resources/states/deviations/count
http
read
/api/v2/resources/states/deviations/services
http
read
/api/v2/resources/states/deviations
http
read
/api/v2/services/+
http
read
Edit service templates
/api/resources/schemas
http
read
/api/validate/service
http
write
Listing CW’s resources on the Rule Sandbox
/api/v2/resources
http
read
Load configuration needed to manage users and roles
/api/auth/ldap
http
read
/api/auth/mfa
http
read
Load service’s commissioning file
/api/v2/services/+/serviceCommissioningFile
http
read
Loading agents
/api/v2/resource-runners
http
read
Loading connection’s details
/api/v2/resources/+
http
read
/api/v2/resources/states
http
read
Loading connections
/api/v2/resources/states/deviations/count
http
read
/api/v2/resources/states
http
read
/api/v2/resources
http
read
/api/v2/services/+/resources
http
read
Loading Connectware’s metrics
/api/system/metrics
http
read
/api/system/preflight
http
read
Loading Connectware’s system information
/api/system/info
http
read
/api/system/preflight
http
read
Loading Connectware’s topics
/api/v2/mqtt/topics
http
read
Loading core container’s details
/api/core-containers/+/inspect
http
read
Loading core containers
/api/core-containers/+/inspect
http
read
/api/core-containers/orchestrator
http
read
/api/core-containers
http
read
Loading endpoint’s details
/api/v2/resources/+
http
read
/api/v2/resources/states
http
read
Loading endpoints
/api/v2/resources/states/deviations/count
http
read
/api/v2/resources/states
http
read
/api/v2/resources
http
read
/api/v2/services/+/resources
http
read
Loading logs
/api/core-containers/+/logs
http
read
/api/core-containers/orchestrator
http
read
/api/core-containers
http
read
/api/v2/resources/+
http
read
Loading mapping’s details
/api/v2/resources/+
http
read
/api/v2/resources/states
http
read
Loading mappings
/api/v2/resources/states/deviations/count
http
read
/api/v2/resources/states
http
read
/api/v2/resources
http
read
/api/v2/services/+/resources
http
read
Loading nodes
/api/v2/resources/states/deviations/count
http
read
/api/v2/resources/states
http
read
/api/v2/resources
http
read
Loading server’s details
/api/v2/resources/+
http
read
/api/v2/resources/states
http
read
Loading servers
/api/v2/resources/states/deviations/count
http
read
/api/v2/resources/states
http
read
/api/v2/resources
http
read
/api/v2/services/+/resources
http
read
Loading service container’s details
/api/containers/+/inspect
http
read
Loading service containers
/api/containers/+/inspect
http
read
/api/containers/orchestrator
http
read
/api/containers
http
read
Loading service’s catalog metadata
/api/marketplace/app/meta
http
read
/api/marketplace/app
http
read
/api/marketplace/apps
http
read
Loading service’s details
/api/services/+/dependencies
http
read
/api/services/all-links
http
read
/api/v2/resources/states/deviations/count
http
read
/api/v2/services/+
http
read
Loading service’s Live Data
/api/v2/services/+/resources
http
read
Loading services
/api/services/all-links
http
read
/api/v2/resources/states/deviations/count
http
read
/api/v2/services/stats/count
http
read
/api/v2/services
http
read
Loading volume’s details
/api/volumes/+/inspect
http
read
Loading volumes
/api/volumes
http
read
Managing agents
/api/resources/runners/+
http
write
Managing certificates
/api/certificates/content
http
read
/api/certificates
http
readWrite
Managing connections
/api/v2/resources/+/operation
http
write
Managing Connectware’s backups
/api/maintenance/db/backup
http
readWrite
/api/maintenance/db/restore
http
write
/api/maintenance/db
http
read
Managing Connectware’s license
/api/system/licensefile
http
write
/api/system/refresh
http
read
Managing Connectware’s metrics
/api/system/metrics
http
write
Managing core containers
/api/core-containers/+/operation
http
write
Managing endpoints
/api/v2/resources/+/operation
http
write
Managing mappings
/api/v2/resources/+/operation
http
write
Managing permissions
/api/permissions/ids
http
read
/api/permissions/page
http
read
Managing roles
/api/roles/+
http
write
/api/roles/names
http
read
/api/roles/page
http
read
/api/roles
http
write
Managing servers
/api/v2/resources/+/operation
http
write
Managing service containers
/api/containers/+/operation
http
write
Managing services
/api/services/+/operation
http
write
/api/services/+
http
write
Managing the client registry
/api/client-registry/confirm
http
write
/api/client-registry/lock
http
write
/api/client-registry/open
http
write
/api/client-registry/status
http
read
/api/client-registry
http
read
Managing users
/api/listUsers
http
read
/api/users/+
http
write
/api/users/batch/delete
http
write
/api/users/batch
http
write
/api/users/usernames
http
read
Managing volumes
Managing your own password
/api/users/change-password
http
write
Retrieving CW’s password policy
/api/policy/password
http
read
Subscribing to MQTT Topics
Any
mqtt
read
Use Multi-factor authentication
/api/mfa/disable
http
write
/api/mfa/enable
http
write
/api/mfa/isenrolled
http
read
/api/mfa/regenerate/backupcodes
http
write
/api/mfa/validate
http
write
Using the workbench
/workbench/#
http
readWrite
/workbench
http
readWrite
Last updated
Was this helpful?