Skip to main content
Version: 8.1

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

TypeParameterDescription
StringuserSourceThe user source in which the user is found. Blank will use the default user source.
StringusernameThe 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

Example #1
# Removes user jHopkins from the AcmeWest user source. 
system.user.removeUser("AcmeWest", "jHopkins")