Appwrite is now available as a DigitalOcean 1-click app! Click to install! 🚀
Docs

User Object

Properties

Name Type Description
$id string

User ID.

$createdAt string

User creation date in ISO 8601 format.

$updatedAt string

User update date in ISO 8601 format.

name string

User name.

password string

Hashed user password.

hash string

Password hashing algorithm.

hashOptions algoArgon2
algoScrypt
algoScryptModified
algoBcrypt
algoPhpass
algoSha
algoMd5

Password hashing algorithm configuration.

registration string

User registration date in ISO 8601 format.

status boolean

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

passwordUpdate string

Password update time in ISO 8601 format.

email string

User email address.

phone string

User phone number in E.164 format.

emailVerification boolean

Email verification status.

phoneVerification boolean

Phone verification status.

prefs preferences

User preferences as a key-value object

Examples

JSON

{
    "$id": "5e5ea5c16897e",
    "$createdAt": "2020-10-15T06:38:00.000+00:00",
    "$updatedAt": "2020-10-15T06:38:00.000+00:00",
    "name": "John Doe",
    "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE",
    "hash": "argon2",
    "hashOptions": {
        "memoryCost": 65536,
        "timeCost": 4,
        "threads": 3
    },
    "registration": "2020-10-15T06:38:00.000+00:00",
    "status": true,
    "passwordUpdate": "2020-10-15T06:38:00.000+00:00",
    "email": "john@appwrite.io",
    "phone": "+4930901820",
    "emailVerification": true,
    "phoneVerification": true,
    "prefs": {}
}