This function is used in Python Scripting.

Description

Looks up a specific user in a user source, by username. The full User object is returned except for the user's password.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.user.getUser(userSource, username)

  • Parameters

String userSource - The name of the user source to search for the user in. Can be a blank string to use the Vision Client's default user source.

String username - The username of the user to search for.

  • Returns

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

  • Scope

Gateway, Vision Client, Perspective Session

User Object

The "User" object that is returned contains all of the information about that user, except for the user's password. You can access most of the basic user properties via a call to "get" or "getOrDefault" which returns a default value if the requested item is not present. For example:

user.getOrDefault('schedule')

This will return that user's schedule, or the value of "Always" if no schedule has been set as that is the default schedule. The following are 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 a value property representing the contact information. Both properties are 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.
Code Examples
Code Snippet
# This example will print the first and last name of the current user using the default datasource.
userName = system.security.getUsername()
user = system.user.getUser("", userName)
print user.get('firstname') + " " + user.get('lastname')
Keywords

system user getUser, user.getUser