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.
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.
Canonical form of the user email address.
Whether the user email is from a free email provider.
Whether the user email is from a disposable email provider.
Whether the user email is from a corporate domain.
Whether the user email is in its canonical form.
Whether the password was found in a known data breach the last time it was checked. Null when the password has never been checked.
Phone verification status.
Multi factor authentication status.
User preferences as a key-value object
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.
Whether the user can impersonate other users.
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.
import io.appwrite.Clientimport io.appwrite.coroutines.CoroutineCallbackimport io.appwrite.services.Users
val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setKey("<YOUR_API_KEY>") // Your secret API key
val users = Users(client)
val response = users.create( userId = "<USER_ID>", email = "email@example.com", // optional phone = "+12065550100", // optional password = "password", // optional name = "<NAME>" // optional)Users
users
identities
sessions
memberships
mfa
passkeys
targets
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.
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.
Canonical form of the user email address.
Whether the user email is from a free email provider.
Whether the user email is from a disposable email provider.
Whether the user email is from a corporate domain.
Whether the user email is in its canonical form.
Whether the password was found in a known data breach the last time it was checked. Null when the password has never been checked.
Phone verification status.
Multi factor authentication status.
User preferences as a key-value object
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.
Whether the user can impersonate other users.
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.
import io.appwrite.Clientimport io.appwrite.coroutines.CoroutineCallbackimport io.appwrite.services.Users
val client = Client() .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint .setProject("<YOUR_PROJECT_ID>") // Your project ID .setKey("<YOUR_API_KEY>") // Your secret API key
val users = Users(client)
val response = users.create( userId = "<USER_ID>", email = "email@example.com", // optional phone = "+12065550100", // optional password = "password", // optional name = "<NAME>" // optional)