Nymph.js 1.0.0-beta.113
    Preparing search index...

    Type Alias UserData

    type UserData = {
        abilities?: string[];
        avatar?: string;
        cancelEmailAddress?: string;
        cancelEmailSecret?: string;
        email?: string;
        emailChangeDate?: number;
        enabled?: boolean;
        group?: Group & GroupData;
        groups?: (Group & GroupData)[];
        inheritAbilities?: boolean;
        name?: string;
        nameFirst?: string;
        nameLast?: string;
        nameMiddle?: string;
        newEmailAddress?: string;
        newEmailSecret?: string;
        password?: string;
        passwordTemp?: string;
        phone?: string;
        recoverSecret?: string;
        recoverSecretDate?: number;
        revokeTokenDate?: number;
        salt?: string;
        secret?: string;
        totpSecret?: string;
        username?: string;
    }
    Index

    Properties

    abilities? avatar? cancelEmailAddress? cancelEmailSecret? email? emailChangeDate? enabled? group? groups? inheritAbilities? name? nameFirst? nameLast? nameMiddle? newEmailAddress? newEmailSecret? password? passwordTemp? phone? recoverSecret? recoverSecretDate? revokeTokenDate? salt? secret? totpSecret? username?

    Properties

    abilities?: string[]

    The abilities granted to the user.

    avatar?: string

    The user's avatar URL. (Use $getAvatar() to support Gravatar.)

    cancelEmailAddress?: string

    The old email address.

    cancelEmailSecret?: string

    An email change cancellation secret.

    email?: string

    The user's email address.

    emailChangeDate?: number

    The timestamp of when the email address was last changed.

    enabled?: boolean

    Whether the user can log in.

    group?: Group & GroupData

    The user's primary group.

    groups?: (Group & GroupData)[]

    The user's secondary groups.

    inheritAbilities?: boolean

    Whether the user should inherit the abilities of his groups.

    name?: string

    The user's full name. This is generated from the first, middle, and last names.

    nameFirst?: string

    The user's first name.

    nameLast?: string

    The user's last name.

    nameMiddle?: string

    The user's middle name.

    newEmailAddress?: string

    If the user has changed their email address, this is the new one, awaiting verification.

    newEmailSecret?: string

    An email change proceed secret.

    password?: string

    The password or password hash.

    passwordTemp?: string

    Temporary storage for passwords. This will be hashed before going into the database.

    phone?: string

    The user's telephone number.

    recoverSecret?: string

    A recovery secret.

    recoverSecretDate?: number

    The timestamp of when the recovery secret was issued.

    revokeTokenDate?: number

    If set, this timestamp is the cutoff point for JWT issue dates. Any token issued before this date will not authenticate the user.

    salt?: string

    The password hash salt.

    secret?: string

    A verification secret.

    totpSecret?: string

    Two factor auth secret.

    username?: string

    The user's username.

    Settings

    Member Visibility

    On This Page

    Properties