Atlas

Appearance

Type Alias: User<Preferences> ​

User<Preferences> = object

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2506

User

Type Parameters ​

Preferences ​

Preferences extends Preferences = DefaultPreferences

Properties ​

$createdAt ​

$createdAt: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2514

User creation date in ISO 8601 format.

$id ​

$id: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2510

User ID.

$updatedAt ​

$updatedAt: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2518

User update date in ISO 8601 format.

accessedAt ​

accessedAt: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2582

Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.

email ​

email: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2554

User email address.

emailVerification ​

emailVerification: boolean

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2562

Email verification status.

hash? ​

optional hash?: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2530

Password hashing algorithm.

hashOptions? ​

optional hashOptions?: object

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2534

Password hashing algorithm configuration.

impersonator? ​

optional impersonator?: boolean

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2586

Whether the user can impersonate other users.

impersonatorUserId? ​

optional impersonatorUserId?: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2590

ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.

labels ​

labels: string[]

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2546

Labels for the user.

mfa ​

mfa: boolean

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2570

Multi factor authentication status.

name ​

name: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2522

User name.

password? ​

optional password?: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2526

Hashed user password.

passwordUpdate ​

passwordUpdate: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2550

Password update time in ISO 8601 format.

phone ​

phone: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2558

User phone number in E.164 format.

phoneVerification ​

phoneVerification: boolean

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2566

Phone verification status.

prefs ​

prefs: Preferences

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2574

User preferences as a key-value object

registration ​

registration: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2538

User registration date in ISO 8601 format.

status ​

status: boolean

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2542

User status. Pass true for enabled and false for disabled.

targets ​

targets: Target[]

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2578

A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.