User APIs | New property naming

API users (technical users) used displayName property for their description. A new description property has been introduced to hold the description for API users. During this refactoring the internalName property was renamed to username, because it represents the Bosch IoT Insights wide unique username.

The name property was removed, because it was confusing which name was meant.

Breaking changes:

• Create API user endpoint, does not accept displayName anymore, now the property is named description
• Filtering for audit log and other user referenced can’t be done by description of the API users, but by their username/displayName.

Deprecated usages:

• User Management API to get users:
  • Replaced name property with displayName
  • Replaced internalName property with username
  • New property description contains now what was in displayName for API users
• Placeholders or references should be updated: insights.user.internalName to insights.user.username
• Placeholders or references should be updated: insights.user.name to insights.user.displayName

Find more information in Users how-to guide.