Skip to main content
Version: 8.1

system.user.addRole

This function is used in Python Scripting.

Description

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.

Syntax

system.user.addRole(userSource, role)

Parameters

TypeParameterDescription
StringuserSourceThe user source to add a role to. Blank will use the default user source.
StringroleThe 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

Code Examples

Example #1
# This example adds a role "Operator" to the user source "MyUserSource".
system.user.addRole("MyUserSource", "Operator")