Intro

<span data-node-type="text" data-node-id="KLtGCRJioAHs3Nr0skdda">Appwrite Functions Documentation</span>

Appwrite Functions Documentation

authentication user management

Demo

Test the create account and login, and email verification below

Actions

<span data-node-type="text" data-node-id="iqnsIbxrvLbSNQj1B8O3Q">Appwrite Functions Documentation</span>

Appwrite Functions Documentation

Function Description Parameters Returns
CheckUser Checks if a user is logged in and retrieves their account information.

args.ProjectId (string)

ctx (object)

User account object if logged in, or error object if not logged in
CreateAccount Creates a new user account in Appwrite.

args.ProjectId (string)

args.Email (string)

args.password (string)

ctx (object)

Created account object
CreateEmailSession Creates an email session (logs in a user) using email and password.

args.ProjectId (string)

args.email (string)

args.password (string)

ctx (object)

Session object
SendPasswordRecoveryEmail Initiates the password recovery process by sending a recovery email.

args.ProjectId (string)

args.email (string)

args.redirectUrl (string)

ctx (object)

Recovery object
UpdatePasswordRecovery Completes the password recovery process by updating the user's password.

args.ProjectId (string)

args.userId (string)

args.secret (string)

args.newPassword (string)

ctx (object)

Response object indicating success or failure
UpdateVerification Completes the email verification process.

args.ProjectId (string)

args.userId (string)

args.secret (string)

ctx (object)

Response object indicating success or failure
VerifyEmail Sends an email verification to the user.

args.ProjectId (string)

args.redirectURL (string)

ctx (object)

Verification object
<span data-node-type="text" data-node-id="lOXDgZOkbW2Vr1nQvo0Fz">Appwrite Functions Documentation</span>

Appwrite Functions Documentation

Function Description Parameters Returns
CheckUser Checks if a user is logged in and retrieves their account information.

args.ProjectId (string)

ctx (object)

User account object if logged in, or error object if not logged in
CreateAccount Creates a new user account in Appwrite.

args.ProjectId (string)

args.Email (string)

args.password (string)

ctx (object)

Created account object
CreateEmailSession Creates an email session (logs in a user) using email and password.

args.ProjectId (string)

args.email (string)

args.password (string)

ctx (object)

Session object
SendPasswordRecoveryEmail Initiates the password recovery process by sending a recovery email.

args.ProjectId (string)

args.email (string)

args.redirectUrl (string)

ctx (object)

Recovery object
UpdatePasswordRecovery Completes the password recovery process by updating the user's password.

args.ProjectId (string)

args.userId (string)

args.secret (string)

args.newPassword (string)

ctx (object)

Response object indicating success or failure
UpdateVerification Completes the email verification process.

args.ProjectId (string)

args.userId (string)

args.secret (string)

ctx (object)

Response object indicating success or failure
VerifyEmail Sends an email verification to the user.

args.ProjectId (string)

args.redirectURL (string)

ctx (object)

Verification object