Skip to content
Last updated

The User object represents a user account in the Freddy system, containing personal information, authentication status, organizational details, and system metadata.

Properties

Identity & Authentication

id string required

Unique user identifier. Format: usr_ followed by 32 hexadecimal characters.

email string required

User's email address (primary identifier and login credential).

username string | null optional

User's chosen username (3-100 characters, unique if provided).

Personal Information

full_name string | null optional

User's full name (computed from first_name and last_name if not directly set).

first_name string | null optional

User's first name.

last_name string | null optional

User's last name.

birthday string | null optional

User's date of birth. Format: ISO 8601 date string (YYYY-MM-DD).

gender string | null optional

User's gender.

Account Status

is_active boolean required

Whether the user account is active and can authenticate. Default: true.

last_verified string | null optional

Timestamp when the user's email was last verified. Format: ISO 8601 datetime string. Null if email has never been verified.

last_login string | null optional

Timestamp of the user's last successful login. Format: ISO 8601 datetime string.

Profile & Preferences

profile_image string | null optional

URL to the user's profile image.

timezone string | null optional

User's preferred timezone (IANA timezone identifier).

country_id string | null optional

Reference to the user's country (foreign key to countries table).

post_code string | null optional

User's postal/zip code.

Organization & Roles

global_role_id string | null optional

Reference to the user's global role.

System Metadata

created_at string required

Timestamp when the user account was created. Format: ISO 8601 datetime string.

updated_at string required

Timestamp when the user account was last updated. Format: ISO 8601 datetime string.