Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


New_in
Version8.0.3



Scripting_function



Panel
titleDescription

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.


Panel
titleClient 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.


Panel
titleSyntax

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



Panel
titleCode Examples


Code Block
languagepy
titleCode Snippet
# Removes user jHopkins from the AcmeWest user source.  
system.user.removeUser("AcmeWest", "jHopkins")




Panel
titleKeywords

system user removeUser, user.removeUser