Type alias UserData

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;

Type declaration

  • Optional abilities?: string[]

    The abilities granted to the user.

  • Optional avatar?: string

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

  • Optional cancelEmailAddress?: string

    The old email address.

  • Optional cancelEmailSecret?: string

    An email change cancellation secret.

  • Optional email?: string

    The user's email address.

  • Optional emailChangeDate?: number

    The timestamp of when the email address was last changed.

  • Optional enabled?: boolean

    Whether the user can log in.

  • Optional group?: Group & GroupData

    The user's primary group.

  • Optional groups?: (Group & GroupData)[]

    The user's secondary groups.

  • Optional inheritAbilities?: boolean

    Whether the user should inherit the abilities of his groups.

  • Optional name?: string

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

  • Optional nameFirst?: string

    The user's first name.

  • Optional nameLast?: string

    The user's last name.

  • Optional nameMiddle?: string

    The user's middle name.

  • Optional newEmailAddress?: string

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

  • Optional newEmailSecret?: string

    An email change proceed secret.

  • Optional password?: string

    The password or password hash.

  • Optional passwordTemp?: string

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

  • Optional phone?: string

    The user's telephone number.

  • Optional recoverSecret?: string

    A recovery secret.

  • Optional recoverSecretDate?: number

    The timestamp of when the recovery secret was issued.

  • Optional 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.

  • Optional salt?: string

    The password hash salt.

  • Optional secret?: string

    A verification secret.

  • Optional totpSecret?: string

    Two factor auth secret.

  • Optional username?: string

    The user's username.

Generated using TypeDoc