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 | object | Password hashing algorithm configuration.
Can be one of: AlgoArgon2 model, AlgoScrypt model, AlgoScryptModified model, AlgoBcrypt model, AlgoPHPass model, AlgoSHA model, AlgoMD5 model |
registration | string | User registration date in ISO 8601 format. |
status | boolean | User status. Pass `true` for enabled and `false` for disabled. |
labels | array | Labels for the user. |
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. |
mfa | boolean | Multi factor authentication status. |
prefs | object | User preferences as a key-value object
Can be one of:
|
targets | array | 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.
Can be one of:
|
accessedAt | string | Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. |
Example
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": {
"type": "argon2",
"memoryCost": 65536,
"timeCost": 4,
"threads": 3
},
"registration": "2020-10-15T06:38:00.000+00:00",
"status": true,
"labels": [
"vip"
],
"passwordUpdate": "2020-10-15T06:38:00.000+00:00",
"email": "john@appwrite.io",
"phone": "+4930901820",
"emailVerification": true,
"phoneVerification": true,
"mfa": true,
"prefs": {},
"targets": [
{
"$id": "259125845563242502",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"name": "Aegon apple token",
"userId": "259125845563242502",
"providerId": "259125845563242502",
"providerType": "email",
"identifier": "token"
}
],
"accessedAt": "2020-10-15T06:38:00.000+00:00"
}
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": {
"type": "argon2",
"memoryCost": 65536,
"timeCost": 4,
"threads": 3
},
"registration": "2020-10-15T06:38:00.000+00:00",
"status": true,
"labels": [
"vip"
],
"passwordUpdate": "2020-10-15T06:38:00.000+00:00",
"email": "john@appwrite.io",
"phone": "+4930901820",
"emailVerification": true,
"phoneVerification": true,
"mfa": true,
"prefs": {},
"targets": [
{
"_id": "259125845563242502",
"_createdAt": "2020-10-15T06:38:00.000+00:00",
"_updatedAt": "2020-10-15T06:38:00.000+00:00",
"name": "Aegon apple token",
"userId": "259125845563242502",
"providerId": "259125845563242502",
"providerType": "email",
"identifier": "token"
}
],
"accessedAt": "2020-10-15T06:38:00.000+00:00"
}