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

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

Description

Removes a specific user from the a user source based on username. 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.removeUser(userSource,username )

  • Parameters

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

String username - The username of the user to remove.

  • Returns

UIResponse - An UIResponse object with lists of warnings, errors, and information returned after the removal attempt.

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code Snippet
# Removes user jHopkins from the AcmeWest user source.  
system.user.removeUser("AcmeWest", "jHopkins")
Keywords

system user removeUser, user.removeUser

  • No labels