Skip to content

The "User" object

In all event-handlers that fire after a user has been authenticated, the following line of code returns a User object:

ts
var user = Session.GetUser();

WARNING

The returned object may be null if no user has been authenticated yet. Always check for null before using the User object.

The User object's properties and methods are defined as follows:

ts
class User {
  GetID(): string;
  readonly EMail: string;
  readonly Type: string;
  readonly Subsystems: string[];
  readonly Description: string;
}

All of the above are read-only property values or methods. It is not allowed to edit, change, or otherwise modify a user account inside a script. This object is provided for informational purposes only.