Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


GLOSSARY


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples

ALL USER MANUAL VERSIONS

Ignition 8.1
Ignition 7.9
Ignition 7.8

Deprecated Pages

Skip to end of metadata
Go to start of metadata

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.

Description

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

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

Code Examples
Code 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)
Keywords

system user addUser, user.addUser

  • No labels