You're currently browsing the Ignition 7.9 docs. Click here to view the latest docs.

The following feature is new in Ignition version 7.9.5
Click here to check out the other new features
This function is used in Python Scripting.


Adds a role to 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.


system.user.addRole(userSource, role)

  • Parameters

String userSource - The user source to add a role to. Blank will use the default user source.

String role - The role to add. Role must not be blank and must not already exist.

  • Returns

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

  • Scope


Code Examples
Code Snippet
# This example adds a role "Operator" to the user source "MyUserSource".
system.user.addRole("MyUserSource", "Operator")
  • No labels