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

Services

Rule Sandbox

/services/rule-engine-sandbox

Required 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

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

Volumes

/services/resources/volumes

Required permissions

Optional permissions

Volume

/services/resources/volumes/:resourceId

Required permissions

Optional permissions

Settings

Login

/settings/login

Optional permissions

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

/user/management

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

Resource

Context

Operation

/api/services/+

http

write

/api/services

http

write

Detecting deviations

By using HTTP

Resource

Context

Operation

/api/services/+

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Edit service templates

Resource

Context

Operation

/api/resources/schemas

http

read

/api/validate/service

http

write

Loading agents

By using HTTP

Resource

Context

Operation

/api/system/agents

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading connection’s details

By using HTTP

Resource

Context

Operation

/api/connections/+

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading connections

By using HTTP

Resource

Context

Operation

/api/connections

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading Connectware’s metrics

Resource

Context

Operation

/api/system/metrics

http

read

/api/system/preflight

http

read

Loading Connectware’s system information

Resource

Context

Operation

/api/permissions

http

read

/api/system/info

http

read

/api/system/preflight

http

read

/api/users/change-password

http

write

Loading Connectware’s topics metadata

Resource

Context

Operation

/api/topics

http

read

Loading core container’s details

By using HTTP

Resource

Context

Operation

/api/core-containers/+/inspect

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading core containers

By using HTTP

Resource

Context

Operation

/api/core-containers/+/inspect

http

read

/api/core-containers/orchestrator

http

read

/api/core-containers

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading endpoint’s state

By using HTTP

Resource

Context

Operation

/api/endpoints/+/state

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading endpoints

By using HTTP

Resource

Context

Operation

/api/endpoints

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading endpont’s details

By using HTTP

Resource

Context

Operation

/api/endpoints/+/topics

http

read

/api/endpoints/+

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading logs

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

Loading mapping’s details

By using HTTP

Resource

Context

Operation

/api/mappings/+/endpoint-topics

http

read

/api/mappings/+

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading mapping’s state

By using HTTP

Resource

Context

Operation

/api/mappings/+/state

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading mappings

By using HTTP

Resource

Context

Operation

/api/mappings

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading node’s state

By using HTTP

Resource

Context

Operation

/api/nodes/+/state

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading nodes

By using HTTP

Resource

Context

Operation

/api/nodes

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading server’s details

By using HTTP

Resource

Context

Operation

/api/servers/+

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading servers

By using HTTP

Resource

Context

Operation

/api/servers

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading service container’s details

By using HTTP

Resource

Context

Operation

/api/containers/+/inspect

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading service containers

By using HTTP

Resource

Context

Operation

/api/containers/+/inspect

http

read

/api/containers/orchestrator

http

read

/api/containers

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading service’s catalog metadata

Resource

Context

Operation

/api/marketplace/app/meta

http

read

/api/marketplace/app

http

read

/api/marketplace/apps

http

read

Loading service’s details

By using HTTP

Resource

Context

Operation

/api/services/+/dependencies

http

read

/api/services/+

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading services

By using HTTP

Resource

Context

Operation

/api/services/+

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading volume’s details

By using HTTP

Resource

Context

Operation

/api/volumes/+/inspect

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Loading volumes

By using HTTP

Resource

Context

Operation

/api/volumes

http

read

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Managing agents

Resource

Context

Operation

#

mqtt

readWrite

Managing certificates

Resource

Context

Operation

/api/certificates/+

http

read

/api/certificates

http

readWrite

Managing connections

By using HTTP

Resource

Context

Operation

/api/connections/+/operation

http

write

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Managing Connectware’s backups

Resource

Context

Operation

/api/maintenance/db/+

http

readWrite

/api/maintenance/db

http

read

Managing Connectware’s license

Resource

Context

Operation

/api/system/licensefile

http

write

/api/system/refresh

http

read

Managing Connectware’s metrics

Resource

Context

Operation

/api/system/metrics

http

write

Managing core containers

Resource

Context

Operation

/api/core-containers/+/operation

http

write

Managing endpoints

By using HTTP

Resource

Context

Operation

/api/endpoints/+/operation

http

write

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Managing mappings

By using HTTP

Resource

Context

Operation

/api/mappings/+/operation

http

write

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Managing permissions

Resource

Context

Operation

/api/permissions/#

http

read

Managing roles

Resource

Context

Operation

/api/roles/#

http

readWrite

/api/roles

http

write

Managing servers

By using HTTP

Resource

Context

Operation

/api/servers/+/operation

http

write

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Managing service containers

By using HTTP

Resource

Context

Operation

/api/containers/+/operation

http

write

Or through MQTT

Resource

Context

Operation

#

mqtt

readWrite

Managing services

Resource

Context

Operation

/api/services/+/operation

http

write

/api/services/+

http

write

Managing the client registry

Resource

Context

Operation

/api/client-registry/+

http

readWrite

/api/client-registry

http

read

Managing users

Resource

Context

Operation

/api/auth/ldap

http

read

/api/listUsers

http

read

/api/policy/password

http

read

/api/users/#

http

readWrite

Managing volumes

Resource

Context

Operation

#

mqtt

readWrite

Subscribing to MQTT Topics

Resource

Context

Operation

Any

mqtt

read

Use Multi-factor authentication

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

Using the Rule Engine

Resource

Context

Operation

/api/endpoints

http

read

/api/rule-engine/+

http

write

Using the workbench

Resource

Context

Operation

/workbench/#

http

readWrite

/workbench

http

readWrite