Script User

ScriptUser returns information about a user. It is obtained either by calling application.getUser(), or from the userCurrent attribute in an extension script.

String = getUserLogonReference() Returns the user logon reference of the user.
int = getUserIdentifier() Returns the numeric user identifier of the user.
String = getUserName() Returns the name of the user, or null if the user does not exist.
String = getUserEmail() Returns the email address of the user, or null if no email is defined.
boolean = getUserEnabled() Returns whether the user is currently enabled.
String = getUserCapabilities()

Returns the user capabilities. User capabilities are used to turn parts of the user interface on and off. Capabilities is a blank-delimited string of:

  • The permission type references for all permissions that this user has.
  • Capabilities to indicate whether this user can access account information:
    • account-read – user can read the account node
    • account-execute – user can execute the account node
    • account-read-properties – user can read the account properties node
    • account-change-theme – user can change the account theme

If the user has no capabilities (for example, because they are not signed in), this returns "", not null.

ScriptNode = getUserNode() The user node.
ScriptNode = getAccountNode() The user's account node.
String = getAccountReference() New in 4.1.4. The reference of the user's account.
String = getOwningUserGroupReference() Get the reference of this user's owning user group, or null if they don't have one.

When a ScriptUser object is passed on the userCurrent attribute in an extension script, only the logon reference, user identifier and capabilities are returned. All other methods return null.