Retrieves the list of users in a specific user source. The "User" objects that are returned contain all of the information about that user, except for the user's password.

This scripting function has no Client Permission restrictions.


  • Parameters

String userSource - The name of the user source to find the users in.

  • Returns

List - A list of User objects. Refer also to the PyUser class.

  • Scope

Gateway, Vision Client, Perspective Session

You can access most of the basic user properties via a call to "get" which returns a null value if the requested item is not present. For example:


...will return that user's first name, or a null value if a name hasn't been set. The following list represents the various values you may use in this manner:

  • username
  • firstname
  • lastname
  • notes
  • schedule
  • language

In addition to these properties, the user object has other methods on it to retrieve more information:

  • user.getId() - returns the internal identifier object that the backing user source needs to identify this user
  • user.getRoles() - returns a sequence of strings representing the roles that this user belongs to
  • user.getContactInfo() - returns a sequence of ContactInfo objects. Each of these objects will have a contactType and value property representing the contact information, both strings.
  • user.getScheduleAdjustments() - returns a sequence of ScheduleAdjustment objects. Each of these objects will have two date properties, "start" and "end", a boolean property, "available", and a string property called "note".
  • user.getPath() - returns a QualifiedPath object that represents this user in a deterministic manner.
# This example will print the first and last name of all users, using the default datasource:
users = system.user.getUsers("")
for user in users:
    print user.get('firstname') + " " + user.get('lastname')

system user getUsers, user.getUsers