Interface UserInterface

User entity interface

Represents a user account in the Mosaia platform. Users can be associated with organizations and have various profile information including contact details, social links, and profile metadata.

Example

const user: UserInterface = {
  id: 'user-123',
  email: 'john.doe@example.com',
  name: 'John Doe',
  username: 'johndoe',
  image: 'https://example.com/avatar.jpg',
  description: 'Software Engineer',
  url: 'https://johndoe.com',
  location: 'San Francisco, CA',
  links: {
    github: 'https://github.com/johndoe',
    linkedin: 'https://linkedin.com/in/johndoe'
  },
  active: true
};
interface UserInterface {
    id?: string;
    active?: boolean;
    external_id?: string;
    extensors?: { [key: string]: string };
    record_history?: RecordHistory;
    username?: string;
    name?: string;
    image?: string;
    description?: string;
    email?: string;
    url?: string;
    location?: string;
    links?: { [key: string]: string };
    agents?: any;
    apps?: any;
    clients?: any;
    models?: any;
    orgs?: any;
}

Hierarchy (View Summary)

Properties

id? active? external_id? extensors? record_history? username? name? image? description? email? url? location? links? agents? apps? clients? models? orgs?

Properties

Optionalid

id?: string

Unique identifier for the entity

Optionalactive

active?: boolean

Whether the entity is active

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: { [key: string]: string }

Extended properties for custom integrations

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalusername

username?: string

Unique username for the user

Optionalname

name?: string

Full name of the user

Optionalimage

image?: string

URL to user's profile image/avatar

Optionaldescription

description?: string

User's bio or description

Optionalemail

email?: string

User's email address

Optionalurl

url?: string

User's personal website URL

Optionallocation

location?: string

User's location

Optionallinks

links?: { [key: string]: string }

Social media and other external links

Optional Readonlyagents

agents?: any

Optional Readonlyapps

apps?: any

Optional Readonlyclients

clients?: any

Optional Readonlymodels

models?: any

Optional Readonlyorgs

orgs?: any

Settings

Member Visibility

On This Page

Properties