Actions: User Accounts

create account

Creates an account for a user. Takes in their name, email, and password.

Argument	Description
ConfirmPassword	(Optional) field to confirm the password matches.
Verified	Users that are verified will not receive a verification email.
FirstName	The location of the user’s first name. (Element or Variable).
LastName	The location of the user’s last name.
Email	The location of the user’s email.
Password	The location of the user’s password.

Deletes a user account.

Argument	Description
PasswordRequired	Whether a password is required for user account deletion or not. If this argument is set to ‘false’, the ‘password’ argument can be set to empty.
Email	The email of the user’s account which will be deleted.
Password	The password of the user’s account which will be deleted.

Authenticate the user using email address & password.

Argument	Description
UserEmail	The user’s email.
UserPassword	The user’s password.

Get the current auth status of CanelaDB.
It returns the authetication status from either the local or cloud database as either true or false.

Argument	Description
Output	The location where the auth_status will go (variable or element).
Target	The type of authetication that will occur (local or cloud).

Get the email address of the logged in user.

Argument	Description
Output	The location where the logged in user’s e-mail address will go (variable or element)

Get the first name of the logged in user.

Argument	Description
Output	The location where the logged in user’s first name will go (variable or element)

Logs out the current user.

Reads the user record from the cdbUsers table of the user with the email provided.

Argument	Description
UserEmail	The email of the user whose record will be read.
Output	The location where the results will go (variable or element).

Sends a verification email to an existing user who has not been verified.

Argument	Description
Email	The email of the user’s account where the verification email will be sent to.
Password	The password of the user’s account where the verification email will be sent to.

Updates a record of an existing user in the ‘cdbUsers’ table.

Argument	Description
Data	An array containing key-value pairs of the data to be updated.
Email	The email of the user’s account whose record will be updated.
Password	The password of the user’s account whose record will be updated.
PasswordRequired	Whether a password is required or not for the user record to be updated. If this argument is set to ‘false’, the ‘password’ argument can be set to empty.

This chapter was last updated on Fri 13 Dec 2024 12:14:28 GMT