Create user
Endpoint
posthttps://<REGION>.cloud.appwrite.io/v1/users
Description
Create a new user.
Required scopes
Authentication
setProject() and a server API key (setKey()). For direct REST calls, send X-Appwrite-Project and X-Appwrite-Key.Parameters
User ID. Choose a custom ID or generate a random ID with ID.unique(). Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
User email.
Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
Plain text user password. Must be at least 8 chars.
User name. Max length: 128 chars.
User
User ID.
User creation date in ISO 8601 format.
User update date in ISO 8601 format.
User name.
Hashed user password.
Password hashing algorithm.
Password hashing algorithm configuration.
Object types (7)
User registration date in ISO 8601 format.
User status. Pass true for enabled and false for disabled.
Labels for the user.
Password update time in ISO 8601 format.
User email address.
User phone number in E.164 format.
Email verification status.
Phone verification status.
Multi factor authentication status.
User preferences as a key-value object Can be one of: preferences
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.
Object type
Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
POST /v1/users HTTP/1.1Host: cloud.appwrite.ioContent-Type: application/jsonX-Appwrite-Response-Format: 1.6.0X-Appwrite-Project: <YOUR_PROJECT_ID>X-Appwrite-Key: <YOUR_API_KEY>
{ "userId": "<USER_ID>", "email": "email@example.com", "phone": "+12065550100", "password": , "name": "<NAME>"}Users
users
targets
sessions
memberships
logs
identities
mfa
Create user
Endpoint
posthttps://<REGION>.cloud.appwrite.io/v1/users
Description
Create a new user.
Required scopes
Authentication
setProject() and a server API key (setKey()). For direct REST calls, send X-Appwrite-Project and X-Appwrite-Key.Parameters
User ID. Choose a custom ID or generate a random ID with ID.unique(). Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
User email.
Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
Plain text user password. Must be at least 8 chars.
User name. Max length: 128 chars.
User
User ID.
User creation date in ISO 8601 format.
User update date in ISO 8601 format.
User name.
Hashed user password.
Password hashing algorithm.
Password hashing algorithm configuration.
Object types (7)
User registration date in ISO 8601 format.
User status. Pass true for enabled and false for disabled.
Labels for the user.
Password update time in ISO 8601 format.
User email address.
User phone number in E.164 format.
Email verification status.
Phone verification status.
Multi factor authentication status.
User preferences as a key-value object Can be one of: preferences
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.
Object type
Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
POST /v1/users HTTP/1.1Host: cloud.appwrite.ioContent-Type: application/jsonX-Appwrite-Response-Format: 1.6.0X-Appwrite-Project: <YOUR_PROJECT_ID>X-Appwrite-Key: <YOUR_API_KEY>
{ "userId": "<USER_ID>", "email": "email@example.com", "phone": "+12065550100", "password": , "name": "<NAME>"}