Create account
Endpoint
posthttps://<REGION>.cloud.appwrite.io/v1/account
Description
Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the /account/verfication route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new account session.
Required scopes
Authentication
setProject() and a signed-in user (setSession() or setJWT()). For direct REST calls, send X-Appwrite-Project with session/JWT headers.Rate limit
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.
New user password. Must be between 8 and 256 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.
from appwrite.client import Clientfrom appwrite.services.account import Accountfrom appwrite.models import User
client = Client()client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpointclient.set_project('<YOUR_PROJECT_ID>') # Your project IDclient.set_session('') # The user session to authenticate with
account = Account(client)
result: User = account.create( user_id = '<USER_ID>', email = 'email@example.com', password = 'password', name = '<NAME>' # optional)
print(result.model_dump())Account
account
consents
identities
mfa
passkeys
recovery
sessions
tokens
verification
Create account
Endpoint
posthttps://<REGION>.cloud.appwrite.io/v1/account
Description
Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the /account/verfication route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new account session.
Required scopes
Authentication
setProject() and a signed-in user (setSession() or setJWT()). For direct REST calls, send X-Appwrite-Project with session/JWT headers.Rate limit
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.
New user password. Must be between 8 and 256 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.
from appwrite.client import Clientfrom appwrite.services.account import Accountfrom appwrite.models import User
client = Client()client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpointclient.set_project('<YOUR_PROJECT_ID>') # Your project IDclient.set_session('') # The user session to authenticate with
account = Account(client)
result: User = account.create( user_id = '<USER_ID>', email = 'email@example.com', password = 'password', name = '<NAME>' # optional)
print(result.model_dump())