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.


Alters a specific user in a user source, replacing the previous data with the new data passed in.

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.


system.user.editUser(userSource, user)

  • Parameters

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

User user - The user to update, as a User object. Refer also to the PyUser class.

  • Returns

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

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code Snippet - Editing a User
# Retrieve the user we're going to edit
userToChange = system.user.getUser("default", "george")

# Make a change to the user. In this case, we're adding some contact info
contactInfo = {"email":"","sms": "5551212"}

# Edit the user. Because the user object we're passing in has a user name, the function
#   already knows which user to edit
system.user.editUser("default", userToChange)

system user editUser, user.editUser

  • No labels