Contents
Strategic Partner Links
Sepasoft - MES Modules
Cirrus Link - MQTT Modules
Resources
Knowledge Base Articles
Inductive University
Forum
IA Support
SDK Documentation
SDK Examples
Renames a role in the specified user source. When altering the Gateway System User Source, the Allow User Admin setting must be enabled.
Permission Type: User Management
Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.
system.user.editRole(userSource, oldName, newName)
String userSource - The user source in which the role is found. Blank will use the default user source.
String oldName - The role to edit. Role must not be blank and must exist.
String newName - The new name for the role. Must not be blank.
UIResponse - an object with lists of warnings, errors, and info about the success or failure of the edit.
All
# This example edits the role "Operator" in the user source "MyUserSource" and edits it to the role "User". system.user.editRole("MyUserSource", "Operator", "User")