system.user.removeUser
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​
| Type | Parameter | Description |
|---|---|---|
| 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 - A UIResponse object with lists of warnings, errors, and information returned after the removal attempt. The contents of the lists are accessible from the getter methods.
getWarns()- Returns a list of warning messages that were encountered during the deletion.getErrors()- Returns a list of error messages that were encountered during the deletion.getInfos()- Returns a list of "info" messages that were encountered during the deletion.
These messages represent normal logging events that occurred during the deletion, and can be useful when trying to visualize the events that lead up to a failure.
Scope​
Gateway, Vision Client, Perspective Session
Code Examples​
# Removes user jHopkins from the AcmeWest user source.
system.user.removeUser("AcmeWest", "jHopkins")