Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



Scripting_function


Panel
titleDescription

Adds a role to the specified user source. When altering the Gateway system user source, the Allow User Admin setting must be enabled.

Panel
titleClient 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.

Panel
titleSyntax

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 - A UIResponse object with lists of warnings, errors, and info about the success or failure of the add.

  • Scope

Gateway, Vision Client, Perspective Session

Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet
# This example adds a role "Operator" to the user source "MyUserSource".
system.user.addRole("MyUserSource", "Operator")
Panel
titleKeywords

system user addRole, user.addRole