Versions Compared

Key

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


New_in
Version8.0.3



Scripting_function



Panel
titleDescription

Adds a new user to a user source. Used in combination with getNewUser to create new user. 


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.addUser(userSource, user)

  • Parameters

String userSource - The user source to add a user to. If set to an empty string, the function will attempt to use the project's default user source (if called from a project).

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

  • Returns

UIResponse - A UIResponse object which contains lists of the errors, warnings, and information returned after the add attempt.

  • Scope

Gateway, Vision Client, Perspective Session



Panel
titleCode Examples


Code Block
languagepy
titleCode Snippet - Adding a New User
# Get new user
userToGet = system.user.getNewUser("AcmeWest", "mTrejo")
 
# Add some contact info
contactInfo = {"email":"mTrejo@acmewest.com","sms": "5551234"}
userToGet.addContactInfo(contactInfo)
userToGet.set("password", "thisIsMyPassword")

# Adds a user to the the AcmeWest usersource.
system.user.addUser("AcmeWest", userToGet)




Panel
titleKeywords

system user addUser, user.addUser