Documentation
    Preparing search index...

    Type Alias User

    User Account

    type User = {
        "2FA"?: string;
        "2FA_code"?: string;
        active: number;
        auth_ref: number;
        communicationid?: number | null;
        created: string;
        creatorRef: number;
        CurrentUserID?: number | null;
        email: string;
        first_name: string;
        guest: boolean;
        id: number;
        landingpage?: string;
        last_name: string;
        lastreported?: string | null;
        login: string;
        mobile?: string;
        mobile_phone?: string;
        mobileappcolor?: string | null;
        mobileappname?: string | null;
        modified: string;
        modifierRef?: number | null;
        Phone?: string;
        phonetype?: string | null;
        spoke: string;
        sysadmin: boolean;
        token: string;
    }
    Index

    Properties

    2FA? 2FA_code? active auth_ref communicationid? created creatorRef CurrentUserID? email first_name guest id landingpage? last_name lastreported? login mobile? mobile_phone? mobileappcolor? mobileappname? modified modifierRef? Phone? phonetype? spoke sysadmin token

    Properties

    "2FA"?: string

    2-Factor authentication type (optional)

    "2FA_code"?: string

    2-Factor authentication code (optional)

    active: number

    Whether user is active

    auth_ref: number

    User's authentication reference

    communicationid?: number | null

    Communication ID (optional)

    created: string

    Date when the user was created (ISO 8601)

    creatorRef: number

    Reference to the user that created this user

    CurrentUserID?: number | null

    Current user ID if available (optional)

    email: string

    Contact email address

    first_name: string

    Account holder's first name

    guest: boolean

    Whether account is considered a guest

    id: number

    User ID

    landingpage?: string

    Link to user's landing page (optional)

    last_name: string

    Account holder's last name

    lastreported?: string | null

    Last time this user was reported (optional)

    login: string

    Username for logging in

    mobile?: string

    Mobile info or alternate format (optional)

    mobile_phone?: string

    Contact mobile phone number (optional)

    mobileappcolor?: string | null

    Color theme of user's mobile app (optional)

    mobileappname?: string | null

    Name of user's mobile app (optional)

    modified: string

    Date when the user was last modified (ISO 8601)

    modifierRef?: number | null

    Reference to the user that last modified this user (optional)

    Phone?: string

    Phone number (optional)

    phonetype?: string | null

    Type of phone (optional)

    spoke: string

    Spoke user comes from

    sysadmin: boolean

    Whether account is an admin

    token: string

    Current session token

    Settings

    Member Visibility

    On This Page

    Properties