Administration
The Administration application enables account administrators to manage their users, roles, tenants, applications and business rules and lets them configure a number of settings for their account.
The Administration application enables account administrators to manage their users, roles, tenants, applications and business rules and lets them configure a number of settings for their account.
The following sections will walk you through all functionalities of the Administration application in detail. For your convenience find an overview on the content of this document below:
Section | Content |
---|---|
Home screen | Providing information on your capacity usage and subscribed applications. |
Managing users | How to add a user, edit, disable or delete them. |
Managing permissions | How to add and edit global roles and inventory roles, how to assign them to users, and how to grant application access. |
Managing applications | How to manage subscribed applications and how to manage and configure own applications in your Cumulocity IoT account. |
Managing business rules | How to reprioritize alarms by alarm mappings. |
Managing data | How to manage and configure retention rules for your data and how to manage stored files in the file repository. |
Two-factor authentication | How to activate/deactivate two-factor authentication for a user. |
Changing settings | How to change account settings like application settings or authentication settings, how to manage the properties library and how to configure single sign-on. |
The Home screen of the Administration application provides the following content:
The capacity sections show:
The user management feature allows you to manage the users within your tenant. With this functionality you may:
If your tenant is configured for using single sign-on (SSO) in Software AG Cloud, new users should be created under My Cloud, accessible through the application switcher in the upper right corner, so that they are able to use the single sign-on feature.
For users created via an external authorization server, updating the following settings in Cumulocity IoT will have no effect (will be reset on the next user re-login):
Moreover, password reset in Cumulocity IoT is disabled for users created through an external authentication server.
To view all users in your tenant, click Users in the Accounts menu in the navigator.
A user list will be displayed, providing the following information for each user:
To filter the list by username, you can use the filter field at the left of the top menu bar. With the dropdown list you can filter by global roles. For details on filtering, see Getting started > UI functionalities and features > Filtering.
In order to apply the selected filters click Apply.
Initially, the User page only shows the top-level users. To see all users in your account at once, click Expand all at the right of the top bar. This will expand all top-level users, showing their sub-users. Click Collapse all to just show the top-level users again. For details on user hierarchies, refer to Managing user hierarchies.
Click Add user at the right of the top menu bar.
At the left of the New user window, provide the following information to identify the user:
Field | Description |
---|---|
Username | Serves as a unique user ID to identify the user at the system. Note that the username cannot be changed once the user has been created. This field is mandatory. |
Login alias | In addition to the username, an optional alias can be provided to be used to log on. In contrast to the username, this alias may be changed if required. The login alias cannot be the same as the username. Note that the login alias is not supported for devices. |
Status | Enable/disable the user account here. If the user account is disabled the user cannot login. |
A valid email address. This field is mandatory. | |
First name | First name of the user. |
Last name | Last name of the user. |
Telephone | A valid phone number. The phone number is required if the user is configured to use two-factor authentication. |
Owner | Another user that manages ("owns") the new user. Select a user from the dropdown list and click Done to confirm. Refer to Managing user hierarchies for details on user hierarchies. |
Delegated by | Can be activated to delegate user hierarchies and permissions to the user. Refer to Managing user hierarchies for details on delegation. |
Select the login options for the user.
On the right of the page, select the global roles for the user. Details on global roles are described in Managing permissions.
Click Save to save your settings.
The new user will be added to the user list.
The inventory roles will be copied from the selected user.
Click the menu icon at the right of the respective row and then click Delegate to delegate your user hierarchies and permissions to a user.
Click Undelegate to remove a delegation.
Refer to Managing user hierarchies for details on delegation.
Click the menu icon at the right of the respective row and then click Disable to disable an active user, or click Enable to enable a user that has been disabled.
Click the menu icon at the right of the respective row and then click Delete.
In the event of a security incident involving the session tokens of your tenant’s users, you can invalidate any tokens currently in use.
To revoke all session tokens click Revoke tokens at the right of the top menu bar. Revoking all tokens logs out all users logged in via “OAI-Secure” or “Single sign-on redirect”. Note that JWT tokens retrieved by your devices will also be revoked.
Permissions define what a user is allowed to do in Cumulocity IoT applications. To manage permissions more easily, they are grouped into so-called “roles”. Every user can be associated with a number of roles, adding up permissions of the user.
The following types of roles can be associated with users:
Moreover, application access can be granted to enable a user to use an application.
Click Roles in the Accounts menu to display a list of configured roles.
In the Global roles tab you can find the roles which grant permissions on a system level. There are several global roles pre-defined, but you can define your own according to your needs.
The pre-defined roles are configured as samples for a particular purpose. You may use them as a starting point and further adapt them to your individual needs.
On creating a new user, make sure that the global roles you assign to the user contain all necessary permissions relevant for this particular user in either of those roles assigned. Permissions from different roles are merged together when assigned to the same user. If, for example, a user only has the role “Cockpit User” (see below), the user is only able to access the Cockpit application and nothing more. But if you also assign inventory permission via some of the available roles, the user will get access to the whole inventory, such as devices, groups, and configurations.
The roles “admins” and “devices” have a special status:
Role | Description |
---|---|
admins | Administrative permissions are enabled. The initial administrator, the first user created in a tenant, has this role. |
devices | Typical permission setup for devices. After registration, a device automatically has this role. Edit this role if your devices require less or more permissions, or assign other roles to your devices. |
Furthermore, the following pre-configured roles are initially provided.
Role | Description |
---|---|
CEP Manager | Can access all smart rules and event processing rules. |
Cockpit User | Can access the Cockpit application. In addition, you should add a role providing access to devices. |
Devicemanagement User | Can access the Device Management application. The user will be able to use the simulator and to run bulk operations. In addition, you should add a role providing access to devices. |
Global Manager | Can read and write all data from all devices. |
Global Reader | Can read all data from all devices. |
Global User Manager | Can manage all users. |
Shared User Manager | Can manage sub-users. The subscription plan needs to include user hierarchies to be able to manage sub-users. |
Tenant Manager | Can manage tenant-wide settings, such as own applications, data brokerage, data retention, options and tenant statistics. |
You may also see the following legacy roles:
Role | Description |
---|---|
business | Can access all devices and their data but has no management permission in the tenant. |
readers | Can read all data (including users, in contrast to “Global Readers”). |
Click Add global role in the Global roles tab. In the New global role page you will see a list of permission types at the left and a list of applications to be accessed at the right. The following screenshot shows the settings for the “admins” role.
Permission levels
For each type, you can select the following permission levels:
Select the checkbox at the top of a column to set the respective level to all permission types.
Permission categories
The following permission categories are available by default:
Category | Description |
---|---|
Alarms | View or edit alarms. |
Application management | View or edit the applications available in this account. |
Audits | View or create audit logs. |
Bulk operations | View or create bulk operations. |
CEP management | View or edit CEP rules. |
Data broker | Send data to other tenants or receive data from other tenants. |
Device control | View or edit commands for devices resp. send commands to devices. Also used for device registration. |
Events | View or create events. |
Global smart rules | Configure global smart rules. |
Identity | View or edit identifiers for devices. |
Inventory | View or edit inventory data. |
Measurements | View or create measurements. |
Option management | View or edit account options such as password policies. |
Retention rules | View or edit retention rules. |
Schedule reports | Manage the schedule of report exporting. |
Simulator | Configure simulated devices. |
Sms | Configure SMS. |
Tenant management | View, create, edit or delete subtenants. |
Tenant statistics | View the usage data for this account, as shown on the Home screen of the Administration application. |
User management | View or edit users, global roles and permissions. |
Own user management | View or edit your own user. |
There may be additional permissions visible depending on the features in your subscription plan. These are documented along with the respective feature.
You can assign global roles to users either directly in the user list, or by opening the details page for a particular user and adding them there.
Inventory roles contain permissions that you can assign to groups of devices. For example, an inventory role can contain the permission to restart a device. You can assign this inventory role to a group of devices “region north” and to a user “smith”. The result is that the user “smith” can restart all devices that are in the group “region north” or any of its subgroups.
To view the currently configured inventory roles, click Roles in the Accounts menu and switch to the Inventory roles tab.
In the Inventory roles tab you can manage user permissions for particular groups and/or its children. There are several default inventory roles defined, but you can define your own according to your needs.
The following default inventory roles are initially available in new tenants:
Role | Description |
---|---|
Manager | Can read all data of the asset and manage all inventory data but cannot perform operations. In addition, can manage inventory data (including dashboards) and alarms. |
Operations: All | Can remotely manage the assets by sending operations to a device (for example software updates, remote configurations). |
Operations: Restart Device | Can restart devices. |
Reader | Can read all data of the asset. |
Click Add inventory role in the Inventory roles tab. In the “New inventory role” page, provide a name and a description, and assign the permissions for the new inventory role.
Permissions are grouped into the following categories:
Category | Description |
---|---|
Alarms | Permissions related to working with alarms from devices. |
Audits | Permissions related to audit logs. |
Events | Permissions related to working with events from devices. |
Inventory | Permissions for viewing and editing devices. |
Measurements | Permissions related to measurements. |
Device control | Permissions to remote control devices. |
Full access | Complete access to the associated devices, mainly to simplify configuration. |
Add a permission to the role by clicking the plus icon next to the desired category.
In the Type field, specify a type to further restrict the type of data that this permission applies to. Access will be only granted to objects that contain the specified Type.
For example, assume that your device sends measurements related to device management, such as “c8y_SignalStrength”, and actual production measurements. You want a user to only see the device management measurements. In this case, enter “c8y_SignalStrength” as type. This will allow the user to only see measurements that contain the type “c8y_SignalStrength”. Note that the user will be able to see the entire measurement object including other types that may be part of the same measurement object.
By default, the Type field contains an asterisk “*” selecting all types.
In the Permission field, select a permission level from the dropdown list:
As another example, assume that you are using tracking devices. You want to allow your user to see all devices, but not to change anything. In addition, the user should be able to follow tracks of devices on a map. Tracks are recorded using an event with fragment type “c8y_Position” (see Sensor library). To do so, assign READ permission on inventory as well as on events with type “c8y_Position” as shown in the image below.
Inventory roles are assigned to a user and a group of devices.
To assign inventory roles, click Users in the Accounts menu, select a user in the user list and switch to its Inventory roles tab.
In the Inventory roles tab you will see a tree of device groups. To assign an inventory role, open the dropdown at the right of the group row. Select the relevant roles and click Apply. For a detailed description of a role click the info icon next to it or refer to Inventory roles.
Inventory roles are inherited from groups to all their direct and indirect subgroups, and to the devices in these groups. If you select, for example, a role with read permissions on alarms for a group of devices, the user will be able to see alarms of all devices in this group and all its subgroups.
If a user has inventory access to a group of devices, the user will also have that access to all dashboards for that group of devices in the Cockpit application.
You can also copy inventory roles from another user. To copy roles, click Copy inventory roles from another user. In the upcoming window, select a user from the list and click Copy. At the top you can select if you want to merge the roles with the existing user roles (the default) or if you want to replace the existing user roles. Copying roles makes it easier to manage the permissions of many users as you can create a reference user and then copy the permissions from there.
If you try to perform actions without sufficient permissions, an error message will occur.
To help troubleshooting permissions, click the User button (showing the current user name) at the right of the top bar. From the context menu, select Access denied requests. In the resulting window details on the denied accesses are provided. An administrator user or the product support can help in fixing the permissions.
The Cumulocity IoT platform provides optimized UI performance for users with inventory roles access. In particular, requests for tenants with large inventory hierarchies are faster.
The performance of the following UI pages is improved:
As an administrator, you can disable the performance feature by doing the following:
The option looks like the following in the REST API (see also the Cumulocity IoT OpenAPI Specification):
{"category": "configuration", "key": "acl.algorithm-version", "value": "LEGACY"}
The setting on tenant level has priority over the setting on platform level.
By default, this option is enabled.
The Application Access tab shows a list of all available applications in your tenant in alphabetical order.
To assign applications to the user, simply select the respective applications and click Save.
For more information on application management, see Administration > Managing applications.
Audit logs show the operations that users have carried out.
To view the audit log list, click Audit logs in the Accounts menu. For each log entry, the following information is provided:
Column | Description |
---|---|
Server time | Server time when the operation was processed. |
Event | Type of operation, for example "Alarm created", "Smart rule deleted". Below it, the user who processed it is displayed. |
Description | Provides further information depending on the operation, for example, the device name, alarm text, operation status. |
Device time | Device time when the operation was processed. This can differ from the server time. |
Only the last 100 logs are visible. Scroll down the page to Load more to view more log entries.
In order to easily search through logs, you can filter logs for:
To apply a filter, click the Apply button next to the respective filter field. To discard filters, click the X icon next to the Apply button (only visible if filters are set).
Audit type | Actions |
---|---|
Alarm |
|
Application |
|
Bulk operation |
|
Data broker connector |
|
Devices availability monitoring |
|
Global role |
|
Inventory |
|
Inventory role |
|
Operation |
|
Option |
|
Reliable notification |
|
Report |
|
Single sign-on |
|
Smart rule |
|
Tenant |
|
Tenant auth configuration |
|
Trusted certificate |
|
User |
|
User login |
|
The Cumulocity IoT platform distinguishes between applications and microservices, see also Developing applications in the Concepts guide.
Applications - all web applications either subscribed to the tenant or owned by the tenant.
Microservices - server-side applications used to develop further functionality on top of Cumulocity IoT.
Both can be accessed via the Ecosystem menu in the navigator.
Additionally, in Enterprise tenants, it is possible to configure Default subscriptions, that means you can specify a list of applications that are subscribed by default to every new tenant on creation and/or to all existing tenants on platform upgrade. For details, see Enterprise tenant > Default subscriptions.
Click Applications in the Ecosystem menu in the navigator to display a list or grid of all applications in your account.
In the All applications tab, you can see all applications available in your tenant. There are two kinds of applications:
Your applications are available through the application switcher in the top bar.
Cumulocity IoT provides a variety of applications for different purposes. Depending on your installation and/or optional services your tenant will show a selection of the potentially available applications.
Below all applications are listed which are by default available in the Standard tenant or Enterprise tenant. In addition, numerous optional applications might be subscribed to your tenant.
Name in the UI | Functionality | Identification in the API | Technical type | Availability |
---|---|---|---|---|
Administration | Lets account administrators manage users, roles, tenants and applications | administration | Web application | Standard tenant, Enterprise tenant |
Cockpit | Manage and monitor IoT assets and data from a business perspective | cockpit | Web application | Standard tenant, Enterprise tenant |
Device Management | Manage and monitor devices, and control and troubleshoot devices remotely | devicemanagement | Web application | Standard tenant, Enterprise tenant |
Streaming Analytics | Manage and edit Analytics Builder models and EPL apps (if enabled) | Streaming Analytics | Web application | Standard tenant (limited version for Analytics Builder), Enterprise tenant (full version) |
Custom applications may be:
In the All applications tab, custom applications are labeled as “Custom”.
Click Add application at the top right of the All applications tab.
In the resulting dialog box, select one of the following methods:
The application is created once the ZIP file has been successfully uploaded.
For details on the fields, see also Application properties below.
For details on the fields, see also Application properties below.
Duplicating an application might be useful if you want to customize a subscribed application according to your needs. Duplicating a subscribed application creates a copy of the application as an own application, with a link to the original application.
For details on the fields, see also Application properties below.
To display further details on an application, click it to open its Properties tab.
In the Properties tab, each application will show the following information, depending on the application type (hosted or external):
Field | Description | Hosted (web application) | External |
---|---|---|---|
ID | Unique ID to identify the application | Automatically provided | Automatically provided |
Name | Application name; will be shown as title of the application in the top bar and in the application switcher | Automatically created | Specified by the user |
Application key | Used to identify the application and to make it available for subscription, see the Concepts guide | Automatically created | Specified by the user |
Type | Application type | Hosted | External |
Path | Part of the URL invoking the application | Automatically created | Specified by the user; for example, if you use "hello" as application path, the URL of the application will be "/apps/hello" |
Simply click the application or click the menu icon at the right of an entry and then click Edit.
In the Properties tab, several fields can be modified, depending on the application type (see Application properties).
Click the menu icon at the right of an entry and then click Delete. You can also delete an application directly from the Properties tab in the application details.
If you delete an application that overwrites a subscribed application, the currently subscribed application becomes available to all users. Additionally, the users will then also benefit from future upgrades of the subscribed application.
It is not possible to delete subscribed applications. This can only be done by the owner of the subscribed application.
For custom applications, multiple file versions can be stored in Cumulocity IoT when they were created by uploading either a ZIP file or a MON file. Each version is called an archive. You can upload different versions at the same time and switch between these versions.
Once uploaded, the recently uploaded version is automatically the active version, that is the version of the application that is currently being served to the users of your account. This version cannot be deleted.
Users can restore previous versions of an application from an archive.
If a hosted application is not deployed correctly, users may reactivate it.
The selected application will be reactivated by removing the respective files from the application directory and unpacking the web application package again.
Packages are combinations of plugins and blueprints which can be packed together into a single file and then be deployed to the platform. Thus, packages offer better shareability and reusability of UI features across different applications and allow to add UI features to applications without coding knowledge.
Packages can contain two types of applications:
Blueprint applications must be deployed, while plugins are added to other applications. This allows you to scaffold entire solutions or to extend existing ones. Due to the micro frontend technology, this can happen at runtime without rebuilding.
Switch to the Plugins tab of an application to view all plugins installed on an application.
Packages can be located on the Packages tab in the Applications page.
To add a new package click Add package at the top right.
By clicking on a package, you can see the package details such as Package overview which includes a description and images as well as some meta information which is taken from the package.json.
Additionally, it is possible to view all available plugins within the selected package at the right. To install a plugin click Install plugin and select the desired application.
In the Versions tab, you see all previously uploaded binaries related to the current package. The binaries displayed on this tab can be downloaded via the context menu next to each package version entry.
You can select or upload different versions. Versions indicate the state of the package. They can be used to verify whether a certain package is outdated and needs to be updated. By clicking on a version additional information is provided such as package contents, applications or plugins. Tags can be used to give versions meaningful names. The “latest” tag is used to indicate the default version which will be selected in case no tag is provided. The “latest” tag is set by default to the latest version whenever a version is uploaded without a given tag.
To switch to a different version open the context menu for the desired version and click Set as latest. To delete a version click Delete.
Features are applications which are built-in and not represented by an explicit artifact (like microservices or web applications).
In the Features tab, you will find a list of all features subscribed in your tenant. In an Enterprise tenant, the following features are available by default:
Name in the UI | Functionality | Identification in the API | Availability |
---|---|---|---|
Feature-branding | Customize the look of your tenants to your own preferences | feature-branding | Enterprise tenant |
Feature-broker | Share data selectively with other tenants | feature-broker | Enterprise tenant |
Feature-user-hierarchy | Reflect independent organizational entities in Cumulocity IoT that share the same database | feature-user-hierarchy | Enterprise tenant |
Other features may show up, depending on the individual subscriptions of your tenant.
Click Microservices in the Ecosystem menu in the navigator to display a list or grid of all microservices subscribed to your account.
A microservice is a specific type of application, that is a server-side application used to develop further functionality on top of Cumulocity IoT. As web applications, microservices can either be subscribed to your tenant by the platform or by a service provider, or they can be owned by you as custom applications, see Custom microservices.
Cumulocity IoT provides a variety of microservice applications for different purposes. Depending on your installation and/or optional services your tenant will show a selection of the potentially available applications.
Below you find a list of all microservices which are by default subscribed in a Standard tenant and/or Enterprise tenant. In addition, numerous optional microservices might be subscribed to your tenant.
Name in the UI | Functionality | Identification in the API | Availability |
---|---|---|---|
Apama-ctrl-* | Streaming Analytics microservices, including runtime for Analytics Builder, EPL apps and smart rules. Capabilities and resources vary depending on the microservice variant used | apama-ctrl-* | Standard tenant, Enterprise tenant |
Device-simulator | Simulate all aspects of IoT devices | device-simulator | Standard tenant, Enterprise tenant |
Report agent | Schedule data exports from within the Cockpit application | report agent | Standard tenant, Enterprise tenant |
Smartrule | Use the smart rules engine and create smart rules to perform actions based on realtime data. Requires a variant of the Apama-ctrl microservice | smartrule | Standard tenant, Enterprise tenant |
Sslmanagement | Activate your own custom domain name by using an SSL certificate | sslmanagement | Enterprise tenant |
To display further details on a microservice, click it to open its Properties tab.
In the Properties tab, each microservice will show the following information:
Field | Description | Comment |
---|---|---|
ID | Unique ID to identify the microservice | Automatically provided |
Name | Application name; will be shown as title of the microservice application in the top bar | Automatically inferred from the ZIP file name (recognized version number is dropped), unless provided in the microservice's manifest file |
Application key | Used to identify the microservice application and to make it available for subscription, see the Concepts guide | Automatically created, based on the ZIP file name |
Type | Application type | Microservice |
Path | Part of the URL invoking the application | Automatically created as /service/<microservice-name> |
Below, you will additionally find information on the microservice version, as well as on its isolation level and billing mode, see Enterprise tenant > Usage statistics and billing > Microservice usage for details on these parameters.
At the top right of the Properties tab, you find a toggle to subscribe to or unsubcribe from a microservice.
Changing the subscription is only possible for custom microservices, that is microservices being owned by you.
In the Permissions tab you can view the permissions required for the respective microservice, and the roles provided for it.
You can monitor microservices hosted by Cumulocity IoT in two ways.
The status of the microservice can be checked in the Status tab of the respective microservice application.
To view the status you need the following permissions: role Application management READ and role Inventory READ.
The following information is provided on the Status tab:
Most of the alarms and events visible in the Status tab are strictly technical descriptions of what’s going on with the microservice.
There are two user-friendly alarm types:
c8y_Application_Down
- critical alarm which is created when no microservice instance is available.c8y_Application_Unhealthy
- major alarm which is created when there is at least one microservice instance working properly, but not all of them are fully operating.User-friendly alarms are created for the microservice owner tenant only. They are also automatically cleared when the situation gets back to normal, that is all the microservice instances are working properly.
User-friendly alarms can be used to create smart rules. For details on creating smart rules of various types, see Smart rules.
For example, to send an email, if a microservice is down, create an “On alarm send email” smart rule.
In the On alarm matching section, use c8y_Application_Down
as an alarm type. As a target asset select the microservice which you would like to monitor, for example “echo-agent-server”.
Cumulocity IoT offers viewing logs which provide more details on the status of microservices owned by the tenant.
To view logs, open the Logs tab of the respective microservice.
At the top of the page, you can select the instance of the microservice, for which you want to view the logs.
Next to the instance dropdown you can select the time range for the log entries to be shown by selecting a date from the calendar and entering a time.
At the top right, additional functionality is provided:
Initially, the Logs tab shows the latest logs of the microservice instance.
At the bottom right you find navigation buttons:
If no logs are available in the selected time range, a message is shown accordingly:
There is no possibility to see the logs from the previously running instances or from previously rotated logs exceeding 35 MB. However, inside the instance there is a Docker container running, and if only this one was restarted (not the whole instance) you should see the logs from the currently running and also lately terminated Docker container.
Logs are always loaded from the Docker container using both stdout
and stderr
sources, and there is no possibility to distinguish/filter by the source.
Alarm mapping enables you to change the severity and text of alarms to adapt them to your business priorities. For example, a loss of the connection to a device is by default a MAJOR alarm but may be critical to you. To change this, add an alarm mapping to change alarms related to connection losses to CRITICAL.
Click Alarm mapping in the Business Rules menu to see a list of all alarm mappings.
For each alarm mapping, the alarm severity, the alarm type and a description (optional) are shown.
Expand an alarm mapping to edit it. You may modify the description and the alarm severity. The alarm type is not editable.
To delete an alarm mapping, hover over it and click the delete icon which appears on hovering over the row.
Retention rules gives you control on how long data is stored in your account. By default, all historical data is deleted after 60 days (configurable in the system settings).
You might however want to store measurements for 90 days for example, but delete alarms already after 10 days.
Retention rules are usually run during the night. When you edit a retention rule, you will not see an immediate effect in the Usage section on the Home screen of the Administration application.
Click Retention rules in the Management menu to view a list of retention rules configured for your account.
For each rule, the rule name, details on the data to be deleted (fragment type, type and source, see below) and the maximum age in days is provided.
The asterisk ("*") indicates that data with any value will be cleaned up.
The following data types are covered under retention rules:
The retention rule will be added to the list.
Simply click the row of the rule you want to edit.
For details on the fields, see To add a retention rule.
Hover over the row with the rule you want to delete and click the delete icon that appears on the right.
All retention rules are executed sequentially and independent of each other. So if we have two retention rules, a more specific one with a greater maximum age that defines a subset of the documents that are defined by a more common rule with a lower maximum age, then effectively it will work as if we had a single, more common rule.
For example given the two following rules:
Data type | Fragment type | Type | Source | Maximum age |
---|---|---|---|---|
MEASUREMENT | * | c8y_Temperature | * | 30 days |
MEASUREMENT | * | c8y_Temperature | 12345 | 60 days |
All measurements with the type c8y_Temperature
which are older than 30 days will be removed, including those where the source equals 12345
.
On the other hand when we have the following retention rules defined:
Data type | Fragment type | Type | Source | Maximum age |
---|---|---|---|---|
MEASUREMENT | * | c8y_Temperature | * | 30 days |
MEASUREMENT | * | * | * | 60 days |
The retention process removes the measurements with the type c8y_Temperature
which are older than 30 days, all other measurements will be removed when they are older than 60 days.
The file repository provides an overview of the files stored in your account.
Click Files repository in the Management menu to see a list of files.
The files listed can come from various sources. They can be software images, configuration snapshots taken from devices, log files from devices or web applications uploaded from the All applications page.
For each file, the name of the file, its owner, the file type (for example, image/bmp, text/csv), its size and the date when it was last updated is provided.
Click Upload file in the top menu bar. In the resulting dialog box, select a file to be uploaded. If you want to upload more than one file, click Add file to select another file. You may also delete a file before uploading by clicking the delete icon on the right of the file field.
Click the menu icon at the right of the respective row and then click Download.
Click the menu icon at the right of the respective row and then click Delete.
From the Settings menu, administrators can manage various settings for the account:
ROLES & PERMISSIONS:
To see the Authentication menu item, you must have ADMIN permission for the “Tenant management” permission type or be the first admin user created in the tenant.
For easier user access management, the above permission(s) are/is included in the global role(s) created by default in every new tenant:
Click Authentication in the Settings menu if you want to view or change the Login or TFA settings.
In the Preferred login mode field, you can select one of the following options:
This login mode will be used by the platform’s applications as the default method to authenticate users. Device authentication stays unchanged.
In the field Password validity limit, you can limit the validity of user passwords by specifying the number of days after which users must change their passwords. If you do not want to force your users to change passwords, use “0” for unlimited validity of passwords (default value).
By default, users can use any password with eight characters or more. If you select Enforce that all password are “strong” (green), users must provide strong passwords as described in Getting Started > User options and settings > To change your password.
Even if OAI-Secure authentication is configured for users, basic authentication remains available for devices and microservices using the platform. To provide a higher security level the basic authentication can be restricted.
Use the Forbidden for web browsers toggle to disallow the usage of basic authentication for web browsers. Moreover you can specify the following parameters:
User-Agent
header and having a valid basic authentication date will be accepted.User-Agent
header and using basic authentication will be rejected.OAI-Secure is a more secure alternative to the Basic Auth mode that also supports username and password login. In OAI-Secure mode the credentials in the initial request are exchanged for a JWT token that is set as a cookie in the web browser or returned in the response body. Based on the configuration OAI-Secure can support full session management or work as a standard JWT authentication where the user session lifetime is limited by the token expiration time.
When there is no configuration related to the session, OAI-Secure issues a JWT token with a certain lifetime. If the token expires then the user is forced to re-login because token refresh is not supported. This behavior is very inconvenient for the user if the token lifetime is short because the user is forced to re-login frequently.
Using OAI-Secure with session configuration is more convenient and secure, and can be used to achieve a behavior which is similar to the authentication based on HTTP sessions.
The OAI-Secure token acts as a session identifier on the client side (web browser). Such a token identifier which is stored in the cookie can have a preconfigured short lifetime. Then, the Cumulocity IoT platform is responsible for renewing the session identifier without any user interaction. It is sufficient that the user’s action causes the web browser to send a request to Cumulocity IoT. Then, Cumulocity IoT can examine if the renewing of the session identifier should be executed and perform the operation if necessary. Cumulocity IoT offers extensive configuration related to this behavior so that tenant administrators can adjust the configuration to their needs.
If the Use session configuration option is enabled, the following settings can be configured on tenant level by a tenant administrator:
Field | Description | Default |
---|---|---|
User agent validation required | If turned on, the user agent sent in headers of consecutive requests in the scope of one session will be compared and a request with changed user agent will not be authorized. | false |
Session absolute timeout | Defines the maximum period of time that the user can use Cumulocity IoT without having to re-authenticate. | 14 days |
Session renewal timeout | Expected to be much shorter than the absolute timeout. Defines the time after which Cumulocity IoT tries to provide a new token (session identifier). The renewal may take place only when Cumulocity IoT receives an HTTP request from a client with a non-expired token and the period of time between obtaining the token and the execution of the request is greater than the renewal timeout. | 1 day |
Maximum parallel sessions per user | Defines the maximum number of sessions which can be started by each user (for example on different machines or browsers). When a user exceeds this limit, then the oldest session will be terminated and the user will be logged out on this particular device. | 5 sessions |
Token lifespan | Defines the time for which a token is active. The user is only able to access Cumulocity IoT with a valid token. This configuration option is always available, it does not depend on session configuration. See Token generation with OAI-Secure below. | 2 days |
The time parameters should depend on each other in the following manner: renewal timeout < token lifespan < absolute timeout. Moreover, the renewal timeout should be approximately half of the token lifespan.
Therefore, the recommended settings for a standard use case for OAI-Secure are the following:
In such configurations, the idle timeout is in the range of 45 to 90 minutes, depending on when the last activity for the session was performed.
During the session token renewal the previous token is revoked and a new one is provided. The parameter renewal token delay
defines the delay used to make this process smooth and not disturbing for the user. The old token is still valid for this period (1 minute by default). This way both tokens, old and new, are accepted by Cumulocity IoT. This parameter is only configurable on platform level and cannot be modified by the tenant administrator.
OAI-Secure is primarily based on JWT stored in a browser cookie. It can be also used to generate JWT in the response body.
The lifespan of the tokens and the cookie is configurable by tenant options belonging to the category oauth.internal
.
JWT tokens stored in the browser cookie have a default validity time of two weeks. This can be changed with tenant options:
oauth.internal
;basic-token.lifespan.seconds
;The minimum allowed value is 5 minutes.
Cookies used to store a JWT token in a browser have their own validity time that can be changed with tenant options:
oauth.internal
;basic-user.cookie.lifespan.seconds
;The default value is two weeks. To have the cookie deleted when the user closes the browser, set it to any negative value.
The lifespan of JWT tokens generated in the response body is configured with the following tenant options:
oauth.internal
;body-token.lifespan.seconds
;Refer to the Tenant API in the Cumulocity IoT OpenAPI Specification for more details.
Select the checkbox Allow two-factor authentication if you want to allow TFA in your tenant (only possible for administrators).
You may select one of the following options:
SMS-based, supporting the following settings:
Limit token validity for - lifetime of each session in minutes. When the session expires or a user logs out, the user must enter a new verification code.
Limit verification code validity for - here you can set the lifetime of each verification code sent via SMS. When the verification code expires, the user must request a new verification code in order to login.
Google Authenticator (Time-based One-Time Password = TOTP), supporting the following setting:
Click Save TFA settings to apply your settings.
Click Application in the Settings menu to change applications settings.
Under Default application, you can select a default application from the list which will apply to all users within the tenant. Whenever the platform is accessed, for example, by domain name only, without mentioning a specific application, the application selected as default application is used as default landing page.
Under Access control, administrators can enable cross-origin resource sharing or “CORS” on the Cumulocity IoT API.
The Allowed Domain setting will enable your JavaScript web applications to directly communicate with REST APIs.
http://my.host.com
, http://myother.host.com
to allow applications from http://my.host.com
and from http://myother.host.com
to communicate with the platform.For further information, see http://enable-cors.org.
Click Properties library in the Settings menu, to add custom properties to inventory objects, alarms, events and tenants.
With custom properties, you can extend the data model of Cumulocity IoT built-in objects. You may create the following custom values:
Select the tab for the desired property and click Add property.
In the resulting dialog box, provide a unique name as identifier and a label for the property and select its data type from the dropdown list.
Additionally, select validation rules for the new property:
Checkbox | Description |
---|---|
Required | If selected, the property needs to be provided, for example, during alarm creation. Not available if the property type is "Boolean". |
Default Value | Provide a default value to be automatically filled in the custom property field. Only available for properties with type "string". |
Minimum | Enter a minimum integer value. |
Maximum | Enter a maximum integer value. |
Minimum length | Enter the minimum length required for the string. |
Maximum length | Enter the maximum length required for the string. |
Regular expression | Add a regular expression which will be required in order to fill the custom property field. |
SMS are used throughout the platform for various features like two-factor authentication and user notifications, for example, on alarms.
By providing your credentials you enable platform features that utilize SMS services.
In the SMS provider page, select one of the available SMS providers from the SMS provider dropdown field. You can start typing to filter items and more easily find your preferred provider.
In the resulting dialog, enter the required credentials and properties or specify optional settings, which differ depending on the provider you selected.
Click Save to save your settings.
In the Connectivity page, you can manage credentials for different providers. In order to add or replace credentials ADMIN permissions are required.
The following provider settings may currently be specified:
Depending on the provider you have selected, there may be additional fields, which will be explained in the respective agent documentation, see Protocol integration guide.
The two-factor authentication (TFA) is an extra layer of security that only completes authentication with a combination of two different factors: something the users know (username and password) and something they have (for example, smartphone) or something they are (for example, fingerprint). You can read more on how to configure TFA in the authentication settings section.
There are two possible TFA strategies: Short Message Service (SMS) and Time-based One-Time Password (TOTP). Only one of them can be active at a time.
To check whether TFA is enabled for a certain user, go to the Users page and see the TFA status column right from the password strength column. A key icon indicates that TFA is enabled and by hovering over it you can see the strategy that is being used.
Opposed to the SMS strategy TOTP must be set up by each user. By opening User settings in the top right corner and then clicking Set up two-factor authentication they can start the setup process.
IF TFA is enabled, the user will be presented a QR code at login, that needs to be scanned with the previously installed TOTP mobile application.
Alternatively, the secret can also be inserted manually in case scanning the QR code is not an option.
After this process the mobile application will generate a new code every 30 seconds that can be used to complete the authentication process.
If a user loses access to the TFA code, for example, if a user loses the phone or uninstalls the application, and needs to set it up again, the secret must be revoked. TOTP must be set up by each user individually.
Users can not revoke their own TOTP secret. The secret of a user is only revoked by their respective parent user. See Enterprise tenant > Managing user hierarchies in the User guide for detailed information on user hierarchies.
ROLES & PERMISSIONS:
If a user wants to turn off the use of TOTP (and thus TFA) completely, the secret must be revoked and TOTP enforcement must be disabled. TOTP must be set up by each user individually.
ROLES & PERMISSIONS:
To disable TOTP for a user follow these steps:
Cumulocity IoT provides single sign-on (SSO) functionality, that allows a user to login with a single 3rd-party authorization server using the OAuth2 protocol, for example Azure Active Directory (AAD). Currently authorization code grant is supported only with access tokens in form of JWT. SAML is not supported.
To use the SSO feature the following requirements must be met:
To enable the SSO feature, the administrator must configure a connection with the authorization server. This is done in the Administration application.
SSO configurations can be configured to be exclusively accessible by the Management tenant, thus preventing other tenants from accessing the configurations. Users of such tenants are unable to update the configuration. This removes the risk of an incorrectly configured SSO, which can prevent other users from logging in via SSO. The Management tenant can grant or restrict access to SSO configurations for specific tenants. For more information about configuration access, refer to the Login options API in the Cumulocity IoT OpenAPI Specification.
Click the Single sign-on tab in the Authentication page. Note that the tab is only visible for tenants which have access to the SSO configuration.
At the top left, you can select a template. The selected option has an effect on the look of the panel. The default template is “Custom” which allows for a very detailed configuration with virtually any authorization server using OAuth2 authorization code grant. Other templates provide simplified views for well known and supported authorization servers. In the next steps there will first be a definition of how to use the “Custom” template followed by a view dedicated to Azure Active directory.
As the OAuth protocol is based on the execution of HTTP requests and redirects, a generic request configuration is provided.
The first part of the Single sign-on page consists of the request configuration. Here you can configure the HTTP request address, request parameters, headers and body in case of token and refresh requests. The authorize method is executed as a GET, token and refresh method by POST requests.
Specifying a logout request is optional. It performs front-channel single logout. If configured, the user is redirected to the defined authorization server logout URL after logging out from Cumulocity IoT.
The Basic section of the Single sign-on page consists of the following configuration settings:
Field | Description |
---|---|
Redirect URI | Redirect parameter. Can be used in request definitions as a ${redirectUri} placeholder |
Client ID | OAuth connection client ID. Can be used in request definitions as a ${clientId} placeholder |
Token issuer | OAuth token issuer |
Button name | Name displayed on the button on the Login page |
Provider name | Name of the provider |
Audience | Expected aud parameter of JWT |
Visible on Login page | Indicates whether the login option is enabled or not |
Each time a user logs in, the content of the access token is verified and is a base for user access to the Cumulocity IoT platform. The following section provides the mapping between JWT claims and access to the platform.
In the example above, if a user tries to login a decoded JWT claims look like:
{
...
"user": "john.wick",
...
}
The user will be granted access to the global role “business” and the default application “cockpit”.
If no access mapping matches the user access token, the user will get an “access denied” message when trying to log in. This will also happen if there is no access mapping defined causing all users to be unable to log in using SSO.
New rules can be added by clicking Add access mapping at the bottom. An access mapping statement can consist of multiple checks like in the image below. You can add a rule to an existing statement by clicking and. Click the Minus button to remove a rule.
New roles are added to the user from every matching access mapping. If one access mapping statement assigns the role “admin” and a second one assigns the role “business” and both meet the defined conditions, then the user will be granted access to the global roles “business” and “admin”."
When using “=” as operator you may use wildcards in the Value field. The supported wildcard is asterisk (*) and it matches zero or more characters. For example, if you enter “cur*” this matches “cur”, “curiosity”, “cursor” and anything that starts with “cur”. “f*n” matches “fn”, “fission”, “falcon”, and anything that begins with an “f” and ends with an “n”.
In case the asterisk character should be matched literally it must be escaped by adding a backslash (\). For example, to match exactly the string “Lorem*ipsum” the value must be “Lorem\*ipsum”.
In this case the following claim will match the condition:
{
...
"user": {
"type": "human"
},
"role": [
"ADMIN"
],
...
}
There is an option to verify that a value exists in a list via the “in” operator. Values can also be embedded in other objects. In this case a dot in the key implies looking into an embedded object.
By default, the configuration for dynamic access mapping is selected: Roles selected in the rules above will be reassigned to a user on each log in and other ones will be cleared. This means that dynamic access mapping assigns user roles, based on the access token, on every user login. It is not possible to change the user roles inside Cumulocity IoT as they would be overwritten on the next user login. To change this behavior, select one of the following radio buttons at the bottom of the Access mapping section:
Use dynamic access mapping only on user creation - when selected, dynamic access mapping will be used only when a new user logs in to fill in the initial roles. When a user already exists in Cumulocity IoT, the roles will not be overwritten nor updated.
Roles selected in the rules above will be reassigned to a user on each log in and other ones will be unchanged - when selected, dynamic access mapping will be used on every login, but the roles not listed in the access mapping configuration will not be updated. Only the roles that are listed in the defined access mapping rules will be overwritten.
Selecting one of the two options mentioned above will also enable admins to edit roles of SSO users in the user management. For details, refer to Administration > Managing permissions in the User guide.
When a user logs in with an access token, the username can be derived from a JWT claim. The claim name can be configured in the User ID configuration window. The user ID can be set to any top-level field of the authorization token payload sent from the authorization server to the platform during the login process. We recommend you inspect the authorization token in the audit logs to make sure the correct field is used (see Troubleshooting).
If the Use constant value checkbox is selected, a constant user ID is used for all users who log in to the Cumulocity IoT platform via SSO. This means that all users who log in via SSO share the same user account in the Cumulocity IoT platform. Usage of this option is not recommended.
Next, the User data mappings can be configured:
On user login, user data like first name, last name, email and phone number can also be derived from JWT claims. Each field represents the claim name that is used to retrieve the data from JWT. The user data mapping configuration is optional and as admin manager you can only use the required fields. If the configuration is empty or the claim name cannot be found in the JWT token then the values in the user data are set as empty.
Mapping for alias is not available because it is not used in the context of SSO login.
Each access token is signed by a signing certificate. The following options are available to configure the signing certificates.
Inside some fields you can use placeholders that are resolved by Cumulocity IoT at runtime. Available placeholders are:
Placeholder | Description |
---|---|
clientId | Value of the Client ID field |
redirectUri | Value of the Redirect URI field |
code | Code returned by the authorization server in response to authorization request |
refreshToken | Refresh token returned by the authorization server after token request |
These placeholders can be used in authorization requests, token requests, refresh requests and logout request in the fields:
To use a placeholder in a field, put it inside two curly brackets preceded with a dollar sign:
Placeholders can also be used as a part of text:
The integration was successfully verified against Azure AD using OAuth2 and OpenID Connect (SAML is not supported). The configuration steps are available in https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-protocols-oauth-code.
The following steps illustrate how to use Azure AD (Azure Active Directory) for SSO in Cumulocity IoT.
To connect Cumulocity IoT to Azure AD, you must create an App registration in Azure AD.
The overview in the details page of your App registration contains several IDs and endpoints that you need later on, like the Application (client) ID and the Directory (tenant) ID (for your tenant in Cumulocity IoT).
Moreover, the App registration requires a secret which is used by Cumulocity IoT for the authentication.
Optionally, create a user in Azure AD that you would like to use with Cumulocity IoT.
Navigate to Settings > Authentication in the Administration application and switch to the Single sign-on tab.
Retrieve the relevant information by a GET request to:
https://login.microsoftonline.com/<Directory tenant ID>/.well-known/openid-configuration
The response will look like this:
{
"token_endpoint": "https://login.microsoftonline.com/4d17551b-e234-4e18-9593-3fe717102dfa/oauth2/token",
"token_endpoint_auth_methods_supported": [
"client_secret_post",
"private_key_jwt",
"client_secret_basic"
],
"jwks_uri": "https://login.microsoftonline.com/common/discovery/keys",
"response_modes_supported": [
"query",
"fragment",
"form_post"
],
"subject_types_supported": [
"pairwise"
],
"id_token_signing_alg_values_supported": [
"RS256"
],
"response_types_supported": [
"code",
"id_token",
"code id_token",
"token id_token",
"token"
],
"scopes_supported": [
"openid"
],
"issuer": "https://sts.windows.net/4d17551b-e234-4e18-9593-3fe717102dfa/",
"microsoft_multi_refresh_token": true,
"authorization_endpoint": "https://login.microsoftonline.com/4d17551b-e234-4e18-9593-3fe717102dfa/oauth2/authorize",
"device_authorization_endpoint": "https://login.microsoftonline.com/4d17551b-e234-4e18-9593-3fe717102dfa/oauth2/devicecode",
"http_logout_supported": true,
"frontchannel_logout_supported": true,
"end_session_endpoint": "https://login.microsoftonline.com/4d17551b-e234-4e18-9593-3fe717102dfa/oauth2/logout",
"claims_supported": [
"sub",
"iss",
"cloud_instance_name",
"cloud_instance_host_name",
"cloud_graph_host_name",
"msgraph_host",
"aud",
"exp",
"iat",
"auth_time",
"acr",
"amr",
"nonce",
"email",
"given_name",
"family_name",
"nickname"
],
"check_session_iframe": "https://login.microsoftonline.com/4d17551b-e234-4e18-9593-3fe717102dfa/oauth2/checksession",
"userinfo_endpoint": "https://login.microsoftonline.com/4d17551b-e234-4e18-9593-3fe717102dfa/openid/userinfo",
"kerberos_endpoint": "https://login.microsoftonline.com/4d17551b-e234-4e18-9593-3fe717102dfa/kerberos",
"tenant_region_scope": "EU",
"cloud_instance_name": "microsoftonline.com",
"cloud_graph_host_name": "graph.windows.net",
"msgraph_host": "graph.microsoft.com",
"rbac_url": "https://pas.windows.net"
}
Now enter the following values in the configuration:
Azure | Cumulocity IoT | Value |
---|---|---|
Login URL; OpenID config; Beginning of token endpoint | Azure AD address | Address of your Azure AD tenant, for example “https://login.microsoftonline.com” |
Home > Overview > Primary Domain | Tenant | <directoryName>.onmicrosoft.com, for example “admtest.onmicrosoft.com” |
OpenID config “issuer” | Token issuer | Token issuer value in form of a HTTP address: “https://sts.windows.net/<Directory tenant ID>/”. Note that this won´t work without the tailing slash. |
App registration > <app> > Application (client) ID | Application ID | for example “7fd1ed48-f4b6-4362-b0af-2b753bb1af2b” |
Redirect URI | Address of your Cumulocity IoT tenant followed by /tenant/oauth | |
App registration - <app> > Certificates & secrets > Value | Client secret | Azure AD client secret, for example “hE68Q~uC1.BlSzGJSDC3_UEFvvyIZvRcCxbvV345” |
From OpenID config | Public key discovery URL | “https://login.microsoftonline.com/common/discovery/keys” or “https://login.microsoftonline.com/ |
Optionally single logout can be configured:
Field | Description |
---|---|
Redirect after logout | Activates single logout by redirecting the user, after logout, to the authorization server logout endpoint |
Redirect URL | Address to redirect the user to after successful logout from the authorization server |
After configuring SSO in Cumulocity IoT, you can try to login. You might get an “access denied” error, if this user has no access mapping yet. But you should see a “User login” event and a JSON web token in the audit logs (Administration > Accounts > Audit logs).
The content looks like this:
{
"typ": "JWT",
"alg": "RS256",
"x5t": "2ZQpJ3UpbjAYXYGaXEJl8lV0TOI",
"kid": "2ZQpJ3UpbjAYXYGaXEJl8lV0TOI"
} {
"aud": "7fd1ed48-f4b6-4362-b0af-2b753bb1af2b",
"iss": "https://sts.windows.net/4d17551b-e234-4e18-9593-3fe717102dfa/",
"iat": 1660815959,
"nbf": 1660815959,
"exp": 1660820080,
"acr": "1",
"aio": "ASQA2/8TAAAAg0xPUeu6HKAlgK3vZJsW8TdejlNB3BGSz4XFmJLzPt0=",
"amr": [
"pwd"
],
"appid": "7fd1ed48-f4b6-4362-b0af-2b753bb1af2b",
"appidacr": "1",
"family_name": "Doe",
"given_name": "Jane",
"ipaddr": "51.116.186.93",
"name": "Jane Doe",
"oid": "afbff765-592e-4ae1-9334-b968dad59c84",
"rh": "0.AXkAG1UXTTTiGE6Vkz_nFxAt-kjt0X-29GJDsK8rdTuxryuUAAw.",
"scp": "openid User.Read User.Read.All User.ReadBasic.All",
"sub": "zRTnTukAjU11ME1aqiPMOdwk9jVNmInXbeuoUr_3cYk",
"tid": "4d17551b-e234-4e18-9593-3fe717102dfa",
"unique_name": "jane@admtest.onmicrosoft.com",
"upn": "jane@admtest.onmicrosoft.com",
"uti": "IcTqpKPIA0G_P1Lyw6xBAA",
"ver": "1.0"
} [
256 crypto bytes
]
You can now use the claims to map user attributes and give permissions in the same way as described in the section on the custom template.
Integration with Keycloak allows administrators to use a global logout feature based on OpenId Connect. An event from the Keycloak authorization server is sent to all applications (including the Cumulocity IoT platform) with a logout token that is verified in the same way as the token used in the login process. This feature allows ending sessions on both sides, applications and Keycloak, for the particular user.
To configure the global logout feature follow these steps:
To use the global logout feature follow these steps:
Keycloak also provides a feature which allows administrators to logout all SSO users.
To configure the logout all users feature follow these steps:
To use the logout all users feature follow these steps:
Note that the logout event for all users is only performed in the scope of one Keycloak realm. Moreover, it is only sent for those tenants where the client being used as a configuration for the SSO feature has the correct Admin URL value.
In the Session tab, the Keycloak administrator can also check how many active sessions exist on the respective client and estimate how many tenants and users will be affected by the logout event.
To confirm if the logout event for all users or a single user has been received by the tenant, the Cumulocity IoT administrator can verify if there is information about the logout event in the audit logs. The audit logs are available in the Administration application under Accounts in the Audit Logs tab.
It can be particularly helpful to inspect the content of the authorization token sent to the platform as some of its fields contain the information required for the correct configuration described above.
In Administration application, after clicking on Accounts > Audit logs you can filter by the category “Single sign-on” and look for entries “Json web token claims”.
The contexts of the token will be presented in JSON format.
From the Management tenant, you can configure properties which apply globally to the whole Cumulocity IoT deployment.
Click Configuration in the Settings menu, to access the Configuration page.
Most of the settings you can configure here are also available in the Enterprise tenant. For details, refer to Enterprise tenant > Customizing your platform.
In addition, the following settings can be configured in the Management tenant only.
In the Passwords section, you can specify password settings like default strength, length or validity for the users in your tenant.
Select the checkbox Enforce “green” passwords for all users to enforce the users in your tenant to use passwords that meet the conditions for “green” passwords, see also Getting started > User options and settings.
In the Support user section you can configure the parameters for the support user access for subtenant users.
This feature enables Cumulocity IoT platform providers (Software AG in case of the public cloud instances or service providers with on-prem installations) to support their customers by accessing their users using a support user. A support user is a user in the Management tenant that has specific permissions, that is, to access subtenant users in case of any issues. Refer to Enterprise tenant > Support user access for more information.
In the field Activate support user, specify if support user access is activated for subtenant users. Possible values you can enter here are:
In the Validity limit field, you can optionally specify the support duration, that means, for how many hours support user access will be prolonged after each support user request from a subtenant user. Enter a number specifying the number of hours. The default value is 24 hours.
The expiry date-time will be updated based on the duration specified in the Validity limit field, for example, if the current expiry date-time is 01/09/2018 15:00 and duration has been kept at 24 hours, the enabling support user will update the expiry date to 01/10/2018 15:00.
Details on the status of support requests and support user access for a tenant can be found in the Properties tab of the tenant, see Enterprise tenant > Managing tenants.
A support user is a user in the Management tenant with specific permissions. This user can log in to the target tenant and impersonate the target user.
To configure a user in the Management tenant as support user, you must assign the relevant roles to the user. This can either be done by using a global role or by inventory roles.
Using a global role
Using inventory roles
Using inventory roles, you can selectively assign a support user for specific subtenants.