system.user.editUser
This function is used in Python Scripting.
Description​
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.
Syntax​
system.user.editUser(userSource, user)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| 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​
A UIResponse object with lists of warnings, errors, and information returned after the edit attempt. The contents of the lists are accessible from the getter methods.
getWarns()- Returns a list of warning messages that were encountered during the edit.getErrors()- Returns a list of error messages that were encountered during the edit.getInfos()- Returns a list of "info" messages that were encountered during the edit.
These messages represent normal logging events that occurred during the edit, and can be useful when trying to visualize the events that lead up to a failure.
Scope​
Gateway, Vision Client, Perspective Session
Code Examples​
# 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":"ignition_user@mycompany.com","sms": "5551212"}
userToChange.addContactInfo(contactInfo)
# 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)