User Class Reference

The User class provides access to user account information and profile data within the Magentrix platform. This class is essential for working with user records, personalization, and access control in controllers and Active Classes.

Overview

The User class represents user accounts in the Magentrix platform. Each user has a single assigned Security Role that determines their permissions and access levels. The User class provides properties for profile information, localization settings, and organizational data.

Key Characteristics:

Single role per user (one RoleId assignment)
Support for custom fields through platform customization
Integration with Security Roles for permission control
Localization support (timezone, language, locale, currency)

User Properties Reference

Core Identity Properties

Property	Type	Required	Description
Id	string	Yes	Unique identifier for the user record
Name	string	Auto	Full name (auto-generated from Firstname + Lastname)
Username	string	Yes	Login username (unique across portal)
Firstname	string	Yes	User's first name
Lastname	string	Yes	User's last name
Email	string	Yes	User's email address (validated format)
Alias	string	No	Display alias for privacy settings

Contact Information

Property	Type	Required	Description
Phone	string	No	Primary phone number
MobilePhone	string	No	Mobile phone number
Organization	string	No	Organization name
Title	string	No	Job title
Department	string	No	Department name
Division	string	No	Division name
EmployeeNumber	string	No	Employee identifier

Address Properties

Property	Type	Required	Description
Street	string	No	Street address (multiline)
City	string	No	City name
State	string	No	State or province
Country	string	No	Country name
PostalCode	string	No	ZIP or postal code

Account Status

Property	Type	Required	Description
IsActive	bool	Yes	Whether user account is active (default: true)
AgreedToTerms	bool	No	Whether user accepted terms and conditions
DeactivationDate	DateTime	No	Date when account was deactivated
LastLoginDate	DateTime	Auto	Last successful login timestamp (read-only)

Security and Roles

Property	Type	Required	Description
RoleId	string	Yes	Assigned Security Role ID (single role per user)
Role	Role	Auto	Security Role object (navigation property)
ManagerId	string	No	Manager's User ID
Manager	Person	Auto	Manager object (navigation property)
FederationIdentifier	string	No	SAML Federation identifier for SSO

Localization Settings

Property	Type	Required	Description
Timezone	string	No	User's timezone (picklist value)
Language	string	No	Language code (2-character, e.g., "en")
Locale	string	No	Locale code (5-character, e.g., "en-US")
CurrencyIsoCode	string	No	ISO currency code (3-character, e.g., "USD")

Profile and Social

Property	Type	Required	Description
Description	string	No	About me / bio (255 characters max)
PrivacySetting	short	No	Privacy level: Private (0) or Public (1)
Color	string	No	User's assigned color for UI elements
PhotoUrl	string	Auto	Profile photo URL (read-only)
ThumbnailPhotoUrl	string	Auto	Thumbnail photo URL (read-only)
CoverPhotoPath	string	Auto	Cover photo path (read-only)

System Fields

Property	Type	Required	Description
CreatedOn	DateTime	Auto	Record creation timestamp
CreatedById	string	Auto	User ID who created the record
ModifiedOn	DateTime	Auto	Last modification timestamp
ModifiedById	string	Auto	User ID who last modified the record
OwnerId	string	Auto	Owner ID (always the user themselves)

Table of Contents