This function is used in Python Scripting.

Description

Renames a role in the specified user source. When altering the Gateway System User Source, the Allow User Admin setting must be enabled.

Client Permission Restrictions

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.

Syntax

system.user.editRole(userSource, oldName, newName)

  • Parameters

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.

  • Returns

UIResponse - A UIResponse object with lists of warnings, errors, and info about the success or failure of the edit.

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code Snippet
# This example edits the role "Operator" in the user source "MyUserSource" and edits it to the role "User".
system.user.editRole("MyUserSource", "Operator", "User")
Keywords

system user editRole, user.editRole