Skip to end of metadata
Go to start of metadata

This 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.

Description

Removes a role from 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.removeRole(userSource, role)

  • Parameters

String userSource The user source in which the role is found. Blank will use the default user source.

String role The role to remove. The role must exist.

  • Returns

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

  • Scope

All

Code Examples
Code Snippet
# Removes the role "User" in the user source "MyUserSource".
system.user.removeRole("MyUserSource", "User")