Skip to main content
Version: 8.1

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

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

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Example #1
# 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)